Skip to content

Commit

Permalink
Fixed documentation on GsvaExprData
Browse files Browse the repository at this point in the history
  • Loading branch information
rcastelo committed Apr 12, 2024
1 parent 3ff456d commit 18d1e17
Show file tree
Hide file tree
Showing 11 changed files with 22 additions and 12 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Package: GSVA
Version: 1.50.3
Version: 1.50.4
Title: Gene Set Variation Analysis for Microarray and RNA-Seq Data
Authors@R: c(person("Robert", "Castelo", role=c("aut", "cre"), email="[email protected]"),
person("Justin", "Guinney", role="aut", email="[email protected]"),
Expand All @@ -22,4 +22,4 @@ BugReports: https://github.com/rcastelo/GSVA/issues
Encoding: UTF-8
biocViews: FunctionalGenomics, Microarray, RNASeq, Pathways, GeneSetEnrichment
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
RoxygenNote: 7.3.1
3 changes: 2 additions & 1 deletion R/AllClasses.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
#' Virtual superclass of expression data classes supported by `GSVA`.
#'
#' `GSVA` supports expression data matrices in a growing number of containers
#' and representations. This class union allows to store any of these in a slot
#' and representations. This class union allows to store any of these in a slot
#' of another class as well as defining common methods for all of them.
#'
#' @seealso
Expand All @@ -17,6 +17,7 @@
#' [`SingleCellExperiment-class`],
#' [`HDF5Array`]
#'
#' @aliases GsvaExprData
#' @name GsvaExprData-class
#' @rdname GsvaExprData-class
#' @exportClass GsvaExprData
Expand Down
3 changes: 2 additions & 1 deletion R/gsvaParam.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
#' gene sets, `GSVA` takes four method-specific parameters as described below.
#'
#' @param exprData The expression data. Must be one of the classes
#' supported by [`GsvaExprData-class`].
#' supported by [`GsvaExprData-class`]. Type `help(GsvaExprData)` to consult
#' the available classes.
#'
#' @param geneSets The gene sets. Must be one of the classes supported by
#' [`GsvaGeneSets-class`].
Expand Down
3 changes: 2 additions & 1 deletion R/plageParam.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
#' an expression data set and a collection of gene sets.
#'
#' @param exprData The expression data. Must be one of the classes
#' supported by [`GsvaExprData-class`].
#' supported by [`GsvaExprData-class`]. Type `help(GsvaExprData)` to consult
#' the available classes.
#'
#' @param geneSets The gene sets. Must be one of the classes supported by
#' [`GsvaGeneSets-class`].
Expand Down
3 changes: 2 additions & 1 deletion R/ssgseaParam.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
#' gene sets, `ssGSEA` takes two method-specific parameters as described below.
#'
#' @param exprData The expression data. Must be one of the classes
#' supported by [`GsvaExprData-class`].
#' supported by [`GsvaExprData-class`]. Type `help(GsvaExprData)` to consult
#' the available classes.
#'
#' @param geneSets The gene sets. Must be one of the classes supported by
#' [`GsvaGeneSets-class`].
Expand Down
3 changes: 2 additions & 1 deletion R/zscoreParam.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
#' sets.
#'
#' @param exprData The expression data. Must be one of the classes
#' supported by [`GsvaExprData-class`].
#' supported by [`GsvaExprData-class`]. Type `help(GsvaExprData)` to consult
#' the available classes.
#'
#' @param geneSets The gene sets. Must be one of the classes supported by
#' [`GsvaGeneSets-class`].
Expand Down
3 changes: 2 additions & 1 deletion man/GsvaExprData-class.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion man/gsvaParam-class.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion man/plageParam-class.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion man/ssgseaParam-class.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion man/zscoreParam-class.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 18d1e17

Please sign in to comment.