... | ... |
@@ -511,8 +511,9 @@ loadStudy <- function( |
511 | 511 |
#' |
512 | 512 |
#' @description The `cBioDataPack` function allows the user to |
513 | 513 |
#' download and process cancer study datasets found in MSKCC's cBioPortal. |
514 |
-#' Output datasets use the \linkS4class{MultiAssayExperiment} data |
|
515 |
-#' representation to faciliate analysis and data management operations. |
|
514 |
+#' Output datasets use the |
|
515 |
+#' [MultiAssayExperiment][MultiAssayExperiment::MultiAssayExperiment-class] |
|
516 |
+#' data representation to faciliate analysis and data management operations. |
|
516 | 517 |
#' |
517 | 518 |
#' @details The full list of study identifiers (`studyId`s) can obtained from |
518 | 519 |
#' `getStudies()`. Currently, only ~ 72% of datasets can be represented as |
... | ... |
@@ -536,7 +537,9 @@ loadStudy <- function( |
536 | 537 |
#' @inheritParams downloadStudy |
537 | 538 |
#' @inheritParams cBioPortalData |
538 | 539 |
#' |
539 |
-#' @return A \linkS4class{MultiAssayExperiment} object |
|
540 |
+#' @return A |
|
541 |
+#' [MultiAssayExperiment][MultiAssayExperiment::MultiAssayExperiment-class] |
|
542 |
+#' object |
|
540 | 543 |
#' |
541 | 544 |
#' @seealso <https://www.cbioportal.org/datasets>, [cBioPortalData], |
542 | 545 |
#' [removePackCache] |
... | ... |
@@ -7,13 +7,13 @@ |
7 | 7 |
#' @description The `cBioPortal` class is a representation of the `cBioPortal` |
8 | 8 |
#' API protocol that directly inherits from the `Service` class in the |
9 | 9 |
#' `AnVIL` package. For more information, see the |
10 |
-#' \link[AnVIL:Service]{AnVIL} package. |
|
10 |
+#' [AnVIL][AnVIL:Service-class] package. |
|
11 | 11 |
#' |
12 | 12 |
#' @details This class takes the static API as provided at |
13 | 13 |
#' <https://www.cbioportal.org/api/v2/api-docs> and creates an R object |
14 | 14 |
#' with the help from underlying infrastructure (i.e., |
15 |
-#' \link[rapiclient:rapiclient-package]{rapiclient} and |
|
16 |
-#' \link[AnVIL:Service]{AnVIL}) to give the user a unified representation |
|
15 |
+#' [rapiclient][rapiclient::rapiclient-package] and |
|
16 |
+#' [AnVIL][AnVIL:Service-class]) to give the user a unified representation |
|
17 | 17 |
#' of the API specification provided by the cBioPortal group. Users are not |
18 | 18 |
#' expected to interact with this class other than to use it as input |
19 | 19 |
#' to the functionality provided by the rest of the package. |
... | ... |
@@ -22,7 +22,7 @@ |
22 | 22 |
#' |
23 | 23 |
#' @return A `cBioPortal` class instance |
24 | 24 |
#' |
25 |
-#' @seealso [cBioPortal], \linkS4class{Service} |
|
25 |
+#' @seealso [cBioPortal], [AnVIL][AnVIL:Service-class] |
|
26 | 26 |
#' |
27 | 27 |
#' @examples |
28 | 28 |
#' |
... | ... |
@@ -40,7 +40,7 @@ |
40 | 40 |
#' @importFrom AnVIL operations |
41 | 41 |
#' @importFrom methods callNextMethod |
42 | 42 |
#' |
43 |
-#' @param x A \linkS4class{Service} instance or API representation as |
|
43 |
+#' @param x A [AnVIL][AnVIL:Service-class] instance or API representation as |
|
44 | 44 |
#' given by the [cBioPortal] function. |
45 | 45 |
#' |
46 | 46 |
#' @inheritParams AnVIL::operations |
... | ... |
@@ -226,7 +226,9 @@ update.args <- function(args) { |
226 | 226 |
#' c("acc_tcga_rppa", "acc_tcga_linear_CNA", "acc_tcga_mutations") |
227 | 227 |
#' ) |
228 | 228 |
#' |
229 |
-#' @return A \linkS4class{MultiAssayExperiment} object |
|
229 |
+#' @return A |
|
230 |
+#' [MultiAssayExperiment][MultiAssayExperiment::MultiAssayExperiment-class] |
|
231 |
+#' object |
|
230 | 232 |
#' |
231 | 233 |
#' @seealso [cBioDataPack], [removeDataCache] |
232 | 234 |
#' |
... | ... |
@@ -45,13 +45,16 @@ to be created when using \code{downloadStudy}.} |
45 | 45 |
'pedcbioportal.kidsfirstdrc.org'} |
46 | 46 |
} |
47 | 47 |
\value{ |
48 |
-A \linkS4class{MultiAssayExperiment} object |
|
48 |
+A |
|
49 |
+\link[MultiAssayExperiment:MultiAssayExperiment-class]{MultiAssayExperiment} |
|
50 |
+object |
|
49 | 51 |
} |
50 | 52 |
\description{ |
51 | 53 |
The \code{cBioDataPack} function allows the user to |
52 | 54 |
download and process cancer study datasets found in MSKCC's cBioPortal. |
53 |
-Output datasets use the \linkS4class{MultiAssayExperiment} data |
|
54 |
-representation to faciliate analysis and data management operations. |
|
55 |
+Output datasets use the |
|
56 |
+\link[MultiAssayExperiment:MultiAssayExperiment-class]{MultiAssayExperiment} |
|
57 |
+data representation to faciliate analysis and data management operations. |
|
55 | 58 |
} |
56 | 59 |
\details{ |
57 | 60 |
The full list of study identifiers (\code{studyId}s) can obtained from |
... | ... |
@@ -10,7 +10,7 @@ |
10 | 10 |
\S4method{operations}{cBioPortal}(x, ..., .deprecated = FALSE) |
11 | 11 |
} |
12 | 12 |
\arguments{ |
13 |
-\item{x}{A \linkS4class{Service} instance or API representation as |
|
13 |
+\item{x}{A \link[=AnVIL:Service-class]{AnVIL} instance or API representation as |
|
14 | 14 |
given by the \link{cBioPortal} function.} |
15 | 15 |
|
16 | 16 |
\item{...}{additional arguments passed to methods or, for |
... | ... |
@@ -26,14 +26,14 @@ A \code{cBioPortal} class instance |
26 | 26 |
The \code{cBioPortal} class is a representation of the \code{cBioPortal} |
27 | 27 |
API protocol that directly inherits from the \code{Service} class in the |
28 | 28 |
\code{AnVIL} package. For more information, see the |
29 |
-\link[AnVIL:Service]{AnVIL} package. |
|
29 |
+\link[=AnVIL:Service-class]{AnVIL} package. |
|
30 | 30 |
} |
31 | 31 |
\details{ |
32 | 32 |
This class takes the static API as provided at |
33 | 33 |
\url{https://www.cbioportal.org/api/v2/api-docs} and creates an R object |
34 | 34 |
with the help from underlying infrastructure (i.e., |
35 | 35 |
\link[rapiclient:rapiclient-package]{rapiclient} and |
36 |
-\link[AnVIL:Service]{AnVIL}) to give the user a unified representation |
|
36 |
+\link[=AnVIL:Service-class]{AnVIL}) to give the user a unified representation |
|
37 | 37 |
of the API specification provided by the cBioPortal group. Users are not |
38 | 38 |
expected to interact with this class other than to use it as input |
39 | 39 |
to the functionality provided by the rest of the package. |
... | ... |
@@ -49,5 +49,5 @@ cBioPortal() |
49 | 49 |
|
50 | 50 |
} |
51 | 51 |
\seealso{ |
52 |
-\link{cBioPortal}, \linkS4class{Service} |
|
52 |
+\link{cBioPortal}, \link[=AnVIL:Service-class]{AnVIL} |
|
53 | 53 |
} |
... | ... |
@@ -55,7 +55,9 @@ non-interactive session, data download will be attempted; equivalent to |
55 | 55 |
to be created when using \code{downloadStudy}.} |
56 | 56 |
} |
57 | 57 |
\value{ |
58 |
-A \linkS4class{MultiAssayExperiment} object |
|
58 |
+A |
|
59 |
+\link[MultiAssayExperiment:MultiAssayExperiment-class]{MultiAssayExperiment} |
|
60 |
+object |
|
59 | 61 |
} |
60 | 62 |
\description{ |
61 | 63 |
Obtain a \code{MultiAssayExperiment} object for a particular gene panel, |