Browse code

Fixed NAMESPACE and updated documentation on the rnaseq argument of the main function gsva().

git-svn-id: file:///home/git/hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/GSVA@128904 bc3139a8-67e5-0310-9ffc-ced21a209358

Robert Castelo authored on 19/04/2017 20:44:29
Showing 3 changed files

... ...
@@ -1,5 +1,5 @@
1 1
 Package: GSVA
2
-Version: 1.23.5
2
+Version: 1.23.6
3 3
 Title: Gene Set Variation Analysis for microarray and RNA-seq data
4 4
 Authors@R: c(person("Justin", "Guinney", role=c("aut", "cre"), email="justin.guinney@sagebase.org"),
5 5
              person("Robert", "Castelo", role="aut", email="robert.castelo@upf.edu"))
... ...
@@ -5,6 +5,19 @@ import(BiocGenerics)
5 5
 
6 6
 importClassesFrom(Biobase, ExpressionSet)
7 7
 importClassesFrom(GSEABase, GeneSetCollection)
8
+
9
+importMethodsFrom(Biobase, featureNames,
10
+                           phenoData,
11
+                           experimentData)
12
+
13
+importMethodsFrom(GSEABase, geneIds,
14
+                            incidence)
15
+
16
+importFrom(graphics, plot)
17
+importFrom(stats, ecdf,
18
+                  na.omit)
19
+importFrom(utils, setTxtProgressBar,
20
+                  txtProgressBar)
8 21
 importFrom(Biobase, exprs)
9 22
 importFrom(Biobase, annotation)
10 23
 importFrom(GSEABase, AnnoOrEntrezIdentifier)
... ...
@@ -97,8 +97,12 @@ Estimates GSVA enrichment scores.
97 97
                 while in the case of \code{plage} they are used to calculate the singular value decomposition
98 98
                 (SVD) over the genes in the gene set and use the coefficients of the first right-singular vector
99 99
                 as pathway activity profile.}
100
-  \item{rnaseq}{Flag to inform whether the input gene expression data comes from microarray
101
-                (\code{rnaseq=FALSE}, default) or RNA-Seq (\code{rnaseq=TRUE}) experiments.}
100
+  \item{rnaseq}{Logical flag set by default to \code{rnaseq=FALSE} to inform whether the input gene
101
+                expression data are continues values, such as fluorescent units in logarithmic scale
102
+                from microarray experiments or some other kind of continuous value derived from
103
+                RNA-seq counts such as log-CPMs, log-RPKMs or log-TPMs. This flag should be set to
104
+                \code{rnaseq=TRUE} only when the values of the input gene expression data are integer
105
+                counts.}
102 106
   \item{abs.ranking}{Flag to determine whether genes should be ranked according to 
103 107
   					their sign (\code{abs.ranking=FALSE}) or by absolute value (\code{abs.ranking=TRUE}). 
104 108
   					In the latter, pathways with genes enriched on either extreme
... ...
@@ -148,6 +152,16 @@ identifiers in the input expression data leading to a filtered collection of
148 152
 gene sets. This collection can be further filtered to require a minimun and/or
149 153
 maximum size of the gene sets for which we want to calculate GSVA enrichment
150 154
 scores, by using the arguments \code{min.sz} and \code{max.sz}.
155
+
156
+The name of the argument \code{rnaseq} can be misleading. When set to \code{rnaseq=FALSE}, the
157
+nonparametric estimation of the cumulative density function of the expression profile of
158
+each gene across samples is done using Gaussian kernels suited for continuous values. These were
159
+initially thought to be only microarray fluorescent units in logarithmic scale but nowadays these
160
+may also correspond to continuous values derived from RNA-seq experiments such as log-CPMs,
161
+log-RPKMs or log-TPMs. When \code{rnaseq=TRUE}, Poisson kernels are used instead and therefore,
162
+this option is only suitable when the input gene expression matrix is formed by integer counts.
163
+This implies that \code{rnaseq=FALSE} may also be used even when the expression data comes from
164
+a RNA-seq experiment. The name of this argument may change in the future to avoid this confusion.
151 165
 }
152 166
 \value{
153 167
 A gene-set by sample matrix of GSVA enrichment scores.