... | ... |
@@ -6,7 +6,15 @@ utils::globalVariables(c("clinicalAttributeId", "value", "sampleId")) |
6 | 6 |
#' |
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 |
-#' `AnVIL` package |
|
9 |
+#' `AnVIL` package. For more information, see the 'AnVIL' package. |
|
10 |
+#' |
|
11 |
+#' @details This class takes the static API as provided at |
|
12 |
+#' \url{https://www.cbioportal.org/api/api-docs} and creates an R object |
|
13 |
+#' with the help from underlying infrastructure (i.e., 'rapiclient' and |
|
14 |
+#' 'AnVIL') to give the user a unified representation of the API |
|
15 |
+#' specification provided by the cBioPortal group. Users are not |
|
16 |
+#' expected to interact with this class other than to use it as input |
|
17 |
+#' to the functionality provided by the rest of the package. |
|
10 | 18 |
#' |
11 | 19 |
#' @importFrom methods new |
12 | 20 |
#' |
... | ... |
@@ -8,7 +8,16 @@ |
8 | 8 |
\description{ |
9 | 9 |
The `cBioPortal` class is a representation of the cBioPortal |
10 | 10 |
API protocol that directly inherits from the `Service` class in the |
11 |
- `AnVIL` package |
|
11 |
+ `AnVIL` package. For more information, see the 'AnVIL' package. |
|
12 |
+} |
|
13 |
+\details{ |
|
14 |
+This class takes the static API as provided at |
|
15 |
+ \url{https://www.cbioportal.org/api/api-docs} and creates an R object |
|
16 |
+ with the help from underlying infrastructure (i.e., 'rapiclient' and |
|
17 |
+ 'AnVIL') to give the user a unified representation of the API |
|
18 |
+ specification provided by the cBioPortal group. Users are not |
|
19 |
+ expected to interact with this class other than to use it as input |
|
20 |
+ to the functionality provided by the rest of the package. |
|
12 | 21 |
} |
13 | 22 |
\examples{ |
14 | 23 |
|