Browse code

include return values in doc

LiNk-NY authored on 29/04/2020 16:18:13
Showing 6 changed files

... ...
@@ -164,6 +164,8 @@ eval.args <- function(args) {
164 164
 #'     molecularProfileIds = c("acc_tcga_rppa", "acc_tcga_linear_CNA")
165 165
 #'     )
166 166
 #'
167
+#' @return A \linkS4class{MultiAssayExperiment} object
168
+#'
167 169
 #' @export
168 170
 cBioPortalData <-
169 171
     function(api, studyId = NA_character_,
... ...
@@ -59,6 +59,7 @@
59 59
 #'
60 60
 #' @md
61 61
 #'
62
+#' @return cBioCache: The path to the cache location
62 63
 #' @export
63 64
 cBioCache <- function(...) {
64 65
     getOption("cBioCache", setCache(..., verbose = FALSE))
... ...
@@ -84,6 +84,8 @@
84 84
 #' @param force logical (default FALSE) whether to force re-download data from
85 85
 #' remote location
86 86
 #'
87
+#' @return The file location of the data tarball
88
+#'
87 89
 #' @keywords internal
88 90
 downloadStudy <- function(cancer_study_id, use_cache = TRUE, force = FALSE)
89 91
 {
... ...
@@ -30,6 +30,9 @@ location of the cache directory}
30 30
 \item{cancer_study_id}{A single string from \code{studiesTable} associated
31 31
 with a study tarball}
32 32
 }
33
+\value{
34
+cBioCache: The path to the cache location
35
+}
33 36
 \description{
34 37
 Managing data downloads is important to save disk space and
35 38
 re-downloading data files. This can be done effortlessly via the integrated
... ...
@@ -31,6 +31,9 @@ from the `genePanels` function}
31 31
 \item{by}{character(1) Either 'entrezGeneId' or 'hugoGeneSymbol' for row
32 32
 metadata}
33 33
 }
34
+\value{
35
+A \linkS4class{MultiAssayExperiment} object
36
+}
34 37
 \description{
35 38
 Obtain a `MultiAssayExperiment` object for a particular gene panel,
36 39
 `studyId`, `molecularProfileIds`, and `sampleListIds` combination. Default
... ...
@@ -17,6 +17,9 @@ not be re-downloaded. A path can also be provided to data cache location.}
17 17
 \item{force}{logical (default FALSE) whether to force re-download data from
18 18
 remote location}
19 19
 }
20
+\value{
21
+The file location of the data tarball
22
+}
20 23
 \description{
21 24
 Provide a `cancer_study_id` from the `studiesTable` and retrieve
22 25
 the study tarball from cBioPortal