README.md
7a6e300f
 # GSVA: gene set variation analysis for microarray and RNA-seq data
 
1eb1284e
 [![Bioconductor Time](https://bioconductor.org/shields/years-in-bioc/GSVA.svg)](https://bioconductor.org/packages/release/bioc/html/GSVA.html "How long has been GSVA in a release of Bioconductor")
509a21c1
 [![Bioconductor Downloads](https://bioconductor.org/shields/downloads/release/GSVA.svg)](https://bioconductor.org/packages/stats/bioc/GSVA/ "Ranking by number of downloads. A lower number means the package is downloaded more frequently. Determined within a package type (software, experiment, annotation, workflow) and uses the number of distinct IPs for the last 12 months.")
 [![Support posts](https://bioconductor.org/shields/posts/GSVA.svg)](https://support.bioconductor.org/t/GSVA/ "Support site activity on GSVA, last 6 months: answered posts/total posts.")
bbb4b100
 [![R-CMD-check-bioc](https://github.com/rcastelo/GSVA/workflows/R-CMD-check-bioc/badge.svg)](https://github.com/rcastelo/GSVA/actions?query=workflow%3AR-CMD-check-bioc)
 [![codecov.io](https://codecov.io/github/rcastelo/GSVA/coverage.svg?branch=master)](https://codecov.io/github/rcastelo/GSVA?branch=master)
1ff24893
 <img align="right" src="https://raw.githubusercontent.com/Bioconductor/BiocStickers/master/GSVA/GSVA.png" height="200"/>
7a6e300f
 
bbb4b100
 
 **Current Bioconductor build status**
40dad574
 - `release` [![Bioconductor Availability](https://bioconductor.org/shields/availability/release/GSVA.svg)](https://bioconductor.org/packages/release/bioc/html/GSVA.html#archives "Whether GSVA release is available on all platforms") 
 [![Bioconductor Dependencies](https://bioconductor.org/shields/dependencies/release/GSVA.svg)](https://bioconductor.org/packages/release/bioc/html/GSVA.html#since "Number of recursive dependencies needed to install package")
509a21c1
 [![Bioconductor Commits](https://bioconductor.org/shields/lastcommit/release/bioc/GSVA.svg)](https://bioconductor.org/checkResults/release/bioc-LATEST/GSVA "Time since last commit, possible values: today, < 1 week, < 1 month, < 3 months, since release, before release")
5e9c2f06
 [![Bioconductor Release Build](https://bioconductor.org/shields/build/release/bioc/GSVA.svg)](https://bioconductor.org/checkResults/release/bioc-LATEST/GSVA/ "Bioconductor release build")
40dad574
 - `development` [![Bioconductor Availability](https://bioconductor.org/shields/availability/devel/GSVA.svg)](https://bioconductor.org/packages/devel/bioc/html/GSVA.html#archives "Whether GSVA devel is available on all platforms") 
 [![Bioconductor Dependencies](https://bioconductor.org/shields/dependencies/devel/GSVA.svg)](https://bioconductor.org/packages/devel/bioc/html/GSVA.html#since "Number of recursive dependencies needed to install package")
5e9c2f06
 [![Bioconductor Commits](https://bioconductor.org/shields/lastcommit/devel/bioc/GSVA.svg)](https://bioconductor.org/checkResults/devel/bioc-LATEST/GSVA "Time since last commit, possible values: today, < 1 week, < 1 month, < 3 months, since release, before release")
 [![Bioconductor Devel Build](https://bioconductor.org/shields/build/devel/bioc/GSVA.svg)](https://bioconductor.org/checkResults/devel/bioc-LATEST/GSVA/ "Bioconductor devel build")
7a6e300f
 
edb22333
 The `GSVA` package allows one to perform a change in coordinate systems of molecular measurements, transforming the data from a gene by sample matrix to a gene-set by sample matrix, thereby allowing the evaluation of pathway enrichment for each sample. This new matrix of GSVA enrichment scores facilitates applying standard analytical methods such as functional enrichment, survival analysis, clustering, CNV-pathway analysis or cross-tissue pathway analysis, in a pathway-centric manner. For citing `GSVA` as a software package, please use the following reference:
1ff24893
 
   H&auml;nzelmann S., Castelo R. and Guinney J. GSVA: gene set variation analysis for microarray and RNA-Seq data. BMC _Bioinformatics_, 14:7, 2013.
 
7a6e300f
 ## Installation
 
40dad574
 This is the __development__ version of the R/Bioconductor package GSVA. This version is unstable and should be used only to test new features. If you are looking for the __release__ version of this package please go to its package release landing page at [https://bioconductor.org/packages/GSVA](https://bioconductor.org/packages/GSVA) and follow the instructions there to install it.
7a6e300f
 
d5e87eee
 If you were really looking for this development version, then to install it you need first to install the [development version of Bioconductor](https://bioconductor.org/developers/how-to/useDevel) and then type the following line from the R shell:
7a6e300f
 
 ```r
800edb90
 BiocManager::install("GSVA", version = "devel")
7a6e300f
 ```
 
a16b0ac5
 Alternatively, you can install it from GitHub using the [remotes](https://github.com/r-lib/remotes "remotes") package.
7a6e300f
 
 ```r
a16b0ac5
 install.packages("remotes")
 library(remotes)
7a6e300f
 install_github("rcastelo/GSVA")
 ```
 
 ## Questions, bug reports and issues
 
 For questions and bug reports regarding the __release__ version of **GSVA**
40dad574
 please use the [Bioconductor support site](https://support.bioconductor.org "Bioconductor support site").
5df67ea4
 For feature requests or bug reports and issues regarding this __development__ version of **GSVA**
87312631
 please use the GitHub issues [tab](https://github.com/rcastelo/GSVA/issues) at the top-left of this page.
a16b0ac5
 
 ## Contributing
 
 Contributions to the software codebase of GSVA are welcome as long as contributors abide to the
 terms of the [Bioconductor Contributor Code of Conduct](https://bioconductor.org/about/code-of-conduct).
 If you want to contribute to the development of GSVA please open an
 [issue](https://github.com/rcastelo/GSVA/issues) to start discussing your suggestion or, in case of a
 bugfix or a straightforward feature, directly a
 [pull request](https://github.com/rcastelo/GSVA/pulls).