Update function docs

nuno-agostinho · Feb 3, 2024 · e9f9ae5 · e9f9ae5
1 parent a50b642
commit e9f9ae5
Show file tree

Hide file tree

Showing 19 changed files with 74 additions and 40 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -32,7 +32,7 @@ Depends:
     shinyBS
 License: MIT + file LICENSE
 LazyData: true
-RoxygenNote: 7.1.2
+RoxygenNote: 7.3.1
 Imports:
     AnnotationDbi,
     AnnotationHub,

diff --git a/R/analysis.R b/R/analysis.R
@@ -410,6 +410,8 @@ processSurvTerms <- function(clinical, censoring, event, timeStart,
 
 #' @inherit survival::survfit title details
 #' @inheritParams survdiffTerms
+#' @param formula \code{survTerms} object: survival terms obtained after
+#'   running \code{processSurvTerms} (see examples)
 #' @inheritDotParams survival::survdiff -formula -data
 #'
 #' @importFrom survival survfit

diff --git a/man/calculateLoadingsContribution.Rd b/man/calculateLoadingsContribution.Rd
diff --git a/man/colourInputMod.Rd b/man/colourInputMod.Rd
diff --git a/man/getClinicalMatchFrom.Rd b/man/getClinicalMatchFrom.Rd
diff --git a/man/getDifferentialExpression.Rd b/man/getDifferentialExpression.Rd
diff --git a/man/getDifferentialSplicing.Rd b/man/getDifferentialSplicing.Rd
diff --git a/man/getGroups.Rd b/man/getGroups.Rd
diff --git a/man/getHighlightedPoints.Rd b/man/getHighlightedPoints.Rd
diff --git a/man/getSelectedDataPanel.Rd b/man/getSelectedDataPanel.Rd
diff --git a/man/performPCA.Rd b/man/performPCA.Rd
diff --git a/man/plotDistribution.Rd b/man/plotDistribution.Rd
diff --git a/man/plotICA.Rd b/man/plotICA.Rd
diff --git a/man/processButton.Rd b/man/processButton.Rd
diff --git a/man/processSurvival.Rd b/man/processSurvival.Rd
diff --git a/man/psichomics.Rd b/man/psichomics.Rd
diff --git a/man/styleModal.Rd b/man/styleModal.Rd
diff --git a/man/survdiffTerms.Rd b/man/survdiffTerms.Rd
diff --git a/man/survfit.survTerms.Rd b/man/survfit.survTerms.Rd