cBioPortalData: User Guide
December 10, 2024
Contents
Installation
library(cBioPortalData)
library(AnVIL)Introduction
The cBioPortal for Cancer Genomics website is a great resource for interactive exploration of study datasets. However, it does not easily allow the analyst to obtain and further analyze the data.
We’ve developed the cBioPortalData package to fill this need to
programmatically access the data resources available on the cBioPortal.
The cBioPortalData package provides an R interface for accessing the
cBioPortal study data within the Bioconductor ecosystem.
It downloads study data from the cBioPortal API (the full API specification can be found here https://cbioportal.org/api) and uses Bioconductor infrastructure to cache and represent the data.
We demonstrate common use cases of cBioPortalData and curatedTCGAData
during Bioconductor conference
workshops.
We use the MultiAssayExperiment (Ramos et al. (2017)) package to integrate,
represent, and coordinate multiple experiments for the studies available in the
cBioPortal. This package in conjunction with curatedTCGAData give access to
a large trove of publicly available bioinformatic data. Please see our
JCO Clinical Cancer Informatics publication here (Ramos et al. (2020)).
Citations
Our free and open source project depends on citations for funding. When using
cBioPortalData, please cite the following publications:
citation("MultiAssayExperiment")
citation("cBioPortalData")Overview
Data Structures
Data are provided as a single MultiAssayExperiment per study. The
MultiAssayExperiment representation usually contains SummarizedExperiment
objects for expression data and RaggedExperiment objects for mutation and
CNV-type data. RaggedExperiment is a data class for representing ‘ragged’
genomic location data, meaning that the measurements per sample vary.
For more information, please see the RaggedExperiment and
SummarizedExperiment vignettes.
Identifying available studies
As we work through the data, there are some datasest that cannot be represented
as MultiAssayExperiment objects. This can be due to a number of reasons such
as the way the data is handled, presence of mis-matched identifiers, invalid
data types, etc. To see what datasets are currently not building, we can
look refer to getStudies() with the buildReport = TRUE argument.
cbio <- cBioPortal()## Warning in readLines(url, encoding = "UTF-8"): incomplete final line found on
## '/tmp/Rtmps9JWjB/Rinst3c274d4612dc/cBioPortalData/service/cBioPortal/api.json'studies <- getStudies(cbio, buildReport = TRUE)
head(studies)## # A tibble: 6 × 15
## name description publicStudy pmid citation groups status importDate
## <chr> <chr> <lgl> <chr> <chr> <chr> <int> <chr>
## 1 Adenoid Cysti… Whole-exom… TRUE 2368… Ho et a… ACYC;… 0 2023-12-0…
## 2 Adenoid Cysti… Targeted S… TRUE 2441… Ross et… ACYC;… 0 2023-12-0…
## 3 Adenoid Cysti… Whole-geno… TRUE 2686… Rettig … ACYC;… 0 2023-12-0…
## 4 Adenoid Cysti… WGS of 21 … TRUE 2663… Mitani … ACYC;… 0 2023-12-0…
## 5 Adenoid Cysti… Whole-geno… TRUE 2682… Drier e… ACYC 0 2023-12-0…
## 6 Adenoid Cysti… Whole exom… TRUE 2377… Stephen… ACYC;… 0 2023-12-0…
## # ℹ 7 more variables: allSampleCount <int>, readPermission <lgl>,
## # studyId <chr>, cancerTypeId <chr>, referenceGenome <chr>, api_build <lgl>,
## # pack_build <lgl>The last two columns will show the availability of each studyId for
either download method (pack_build for cBioDataPack and api_build for
cBioPortalData).
Choosing download method
There are two main user-facing functions for downloading data from the cBioPortal API.
cBioDataPackmakes use of the tarball distribution of study data. This is useful when the user wants to download and analyze the entirety of the data as available from the cBioPortal.org website.cBioPortalDataallows a more flexibile approach to obtaining study data based on the available parameters such as molecular profile identifiers. This option is useful for users who have a set of gene symbols or identifiers and would like to get a smaller subset of the data that correspond to a particular molecular profile.
Two main functions
cBioDataPack: Obtain Study Data as Zipped Tarballs
This function will access the packaged data from and return an integrative MultiAssayExperiment representation.
## Use ask=FALSE for non-interactive use
laml <- cBioDataPack("laml_tcga", ask = FALSE)
laml## A MultiAssayExperiment object of 12 listed
## experiments with user-defined names and respective classes.
## Containing an ExperimentList class object of length 12:
## [1] cna: SummarizedExperiment with 24776 rows and 191 columns
## [2] cna_hg19.seg: RaggedExperiment with 13571 rows and 191 columns
## [3] linear_cna: SummarizedExperiment with 24776 rows and 191 columns
## [4] methylation_hm27: SummarizedExperiment with 10968 rows and 194 columns
## [5] methylation_hm450: SummarizedExperiment with 10968 rows and 194 columns
## [6] mrna_seq_rpkm: SummarizedExperiment with 19720 rows and 179 columns
## [7] mrna_seq_rpkm_zscores_ref_all_samples: SummarizedExperiment with 19720 rows and 179 columns
## [8] mrna_seq_rpkm_zscores_ref_diploid_samples: SummarizedExperiment with 19719 rows and 179 columns
## [9] mrna_seq_v2_rsem: SummarizedExperiment with 20531 rows and 173 columns
## [10] mrna_seq_v2_rsem_zscores_ref_all_samples: SummarizedExperiment with 20531 rows and 173 columns
## [11] mrna_seq_v2_rsem_zscores_ref_diploid_samples: SummarizedExperiment with 20440 rows and 173 columns
## [12] mutations: RaggedExperiment with 2584 rows and 197 columns
## Functionality:
## experiments() - obtain the ExperimentList instance
## colData() - the primary/phenotype DataFrame
## sampleMap() - the sample coordination DataFrame
## `$`, `[`, `[[` - extract colData columns, subset, or experiment
## *Format() - convert into a long or wide DataFrame
## assays() - convert ExperimentList to a SimpleList of matrices
## exportClass() - save data to flat filescBioPortalData: Obtain data from the cBioPortal API
This function provides a more flexible and granular way to request a
MultiAssayExperiment object from a study ID, molecular profile, gene panel,
sample list.
acc <- cBioPortalData(api = cbio, by = "hugoGeneSymbol", studyId = "acc_tcga",
genePanelId = "IMPACT341",
molecularProfileIds = c("acc_tcga_rppa", "acc_tcga_linear_CNA")
)## harmonizing input:
## removing 1 colData rownames not in sampleMap 'primary'acc## A MultiAssayExperiment object of 2 listed
## experiments with user-defined names and respective classes.
## Containing an ExperimentList class object of length 2:
## [1] acc_tcga_linear_CNA: SummarizedExperiment with 339 rows and 90 columns
## [2] acc_tcga_rppa: SummarizedExperiment with 57 rows and 46 columns
## Functionality:
## experiments() - obtain the ExperimentList instance
## colData() - the primary/phenotype DataFrame
## sampleMap() - the sample coordination DataFrame
## `$`, `[`, `[[` - extract colData columns, subset, or experiment
## *Format() - convert into a long or wide DataFrame
## assays() - convert ExperimentList to a SimpleList of matrices
## exportClass() - save data to flat filesNote. To avoid overloading the API service, the API was designed to only query a part of the study data. Therefore, the user is required to enter either a set of genes of interest or a gene panel identifier.
Considerations
Note that cBioPortalData and cBioDataPack obtain data diligently curated
by the cBio Portal data team. The original data and curation lies in the
https://github.com/cBioPortal/cBioPortal GitHub repository. However, despite
the curation efforts there may be some inconsistencies in identifiers
in the data. This causes our software to not work as intended though we have
made efforts to represent all the data from both API and tarball formats.
metadata
You may notice that the metadata() may have some additional data that was
not able to be integrated in the MultiAssayExperiment.
metadata(acc)## [[1]]
## # A tibble: 30,510 × 6
## uniqueSampleKey uniquePatientKey entrezGeneId molecularProfileId patientId
## <chr> <chr> <int> <chr> <chr>
## 1 VENHQS1PUi1BNUoxL… VENHQS1PUi1BNUo… 25 acc_tcga_linear_C… TCGA-OR-…
## 2 VENHQS1PUi1BNUoxL… VENHQS1PUi1BNUo… 142 acc_tcga_linear_C… TCGA-OR-…
## 3 VENHQS1PUi1BNUoxL… VENHQS1PUi1BNUo… 207 acc_tcga_linear_C… TCGA-OR-…
## 4 VENHQS1PUi1BNUoxL… VENHQS1PUi1BNUo… 208 acc_tcga_linear_C… TCGA-OR-…
## 5 VENHQS1PUi1BNUoxL… VENHQS1PUi1BNUo… 238 acc_tcga_linear_C… TCGA-OR-…
## 6 VENHQS1PUi1BNUoxL… VENHQS1PUi1BNUo… 242 acc_tcga_linear_C… TCGA-OR-…
## 7 VENHQS1PUi1BNUoxL… VENHQS1PUi1BNUo… 324 acc_tcga_linear_C… TCGA-OR-…
## 8 VENHQS1PUi1BNUoxL… VENHQS1PUi1BNUo… 331 acc_tcga_linear_C… TCGA-OR-…
## 9 VENHQS1PUi1BNUoxL… VENHQS1PUi1BNUo… 367 acc_tcga_linear_C… TCGA-OR-…
## 10 VENHQS1PUi1BNUoxL… VENHQS1PUi1BNUo… 369 acc_tcga_linear_C… TCGA-OR-…
## # ℹ 30,500 more rows
## # ℹ 1 more variable: studyId <chr>
##
## [[2]]
## # A tibble: 2,622 × 6
## uniqueSampleKey uniquePatientKey entrezGeneId molecularProfileId patientId
## <chr> <chr> <int> <chr> <chr>
## 1 VENHQS1PUi1BNUoyL… VENHQS1PUi1BNUo… 207 acc_tcga_rppa TCGA-OR-…
## 2 VENHQS1PUi1BNUoyL… VENHQS1PUi1BNUo… 208 acc_tcga_rppa TCGA-OR-…
## 3 VENHQS1PUi1BNUoyL… VENHQS1PUi1BNUo… 367 acc_tcga_rppa TCGA-OR-…
## 4 VENHQS1PUi1BNUoyL… VENHQS1PUi1BNUo… 472 acc_tcga_rppa TCGA-OR-…
## 5 VENHQS1PUi1BNUoyL… VENHQS1PUi1BNUo… 595 acc_tcga_rppa TCGA-OR-…
## 6 VENHQS1PUi1BNUoyL… VENHQS1PUi1BNUo… 596 acc_tcga_rppa TCGA-OR-…
## 7 VENHQS1PUi1BNUoyL… VENHQS1PUi1BNUo… 598 acc_tcga_rppa TCGA-OR-…
## 8 VENHQS1PUi1BNUoyL… VENHQS1PUi1BNUo… 673 acc_tcga_rppa TCGA-OR-…
## 9 VENHQS1PUi1BNUoyL… VENHQS1PUi1BNUo… 675 acc_tcga_rppa TCGA-OR-…
## 10 VENHQS1PUi1BNUoyL… VENHQS1PUi1BNUo… 898 acc_tcga_rppa TCGA-OR-…
## # ℹ 2,612 more rows
## # ℹ 1 more variable: studyId <chr>Build prompts
You will also get a message for studyIds whose data has not been fully
integrated into a MultiAssayExperiment.
## Our testing shows that '%s' is not currently building.
## Use 'downloadStudy()' to manually obtain the data.
## Proceed anyway? [y/n]: yManual downloads
For this reason, we have also provided the downloadStudy, untarStudy, and
loadStudy functions to allow researchers to simply download the data and
potentially, manually curate it. Generally, we advise researchers to report
inconsistencies in the data in the cBioPortal data repository.
Clearing the cache
cBioDataPack
In cases where a download is interrupted, the user may experience a corrupt
cache. The user can clear the cache for a particular study by using the
removeCache function. Note that this function only works for data downloaded
through the cBioDataPack function.
removeCache("laml_tcga")cBioPortalData
For users who wish to clear the entire cBioPortalData cache, it is
recommended that they use:
unlink("~/.cache/cBioPortalData/")Example Analysis: Kaplan-Meier Plot
We can use information in the colData to draw a K-M plot with a few
variables from the colData slot of the MultiAssayExperiment. First, we load
the necessary packages:
library(survival)
library(survminer)We can check the data to lookout for any issues.
table(colData(laml)$OS_STATUS)##
## 0:LIVING 1:DECEASED
## 67 133class(colData(laml)$OS_MONTHS)## [1] "character"Now, we clean the data a bit to ensure that our variables are of the right type for the subsequent survival model fit.
collaml <- colData(laml)
collaml[collaml$OS_MONTHS == "[Not Available]", "OS_MONTHS"] <- NA
collaml$OS_MONTHS <- as.numeric(collaml$OS_MONTHS)
colData(laml) <- collamlWe specify a simple survival model using SEX as a covariate and we draw
the K-M plot.
fit <- survfit(
Surv(OS_MONTHS, as.numeric(substr(OS_STATUS, 1, 1))) ~ SEX,
data = colData(laml)
)
ggsurvplot(fit, data = colData(laml), risk.table = TRUE)
Data update requests
If you are interested in a particular study dataset that is not currently building, please open an issue at our GitHub repository and we will do our best to resolve the issues with the code base. Data issues can be opened at the cBioPortal data repository.
We appreciate your feedback!
sessionInfo
Click to see session info
sessionInfo()## R Under development (unstable) (2024-10-21 r87258)
## Platform: x86_64-pc-linux-gnu
## Running under: Ubuntu 24.04.1 LTS
##
## Matrix products: default
## BLAS: /home/biocbuild/bbs-3.21-bioc/R/lib/libRblas.so
## LAPACK: /usr/lib/x86_64-linux-gnu/lapack/liblapack.so.3.12.0
##
## locale:
## [1] LC_CTYPE=en_US.UTF-8 LC_NUMERIC=C
## [3] LC_TIME=en_GB LC_COLLATE=C
## [5] LC_MONETARY=en_US.UTF-8 LC_MESSAGES=en_US.UTF-8
## [7] LC_PAPER=en_US.UTF-8 LC_NAME=C
## [9] LC_ADDRESS=C LC_TELEPHONE=C
## [11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C
##
## time zone: America/New_York
## tzcode source: system (glibc)
##
## attached base packages:
## [1] stats4 stats graphics grDevices utils datasets methods
## [8] base
##
## other attached packages:
## [1] survminer_0.5.0 ggpubr_0.6.0
## [3] ggplot2_3.5.1 survival_3.7-0
## [5] cBioPortalData_2.19.4 MultiAssayExperiment_1.33.1
## [7] SummarizedExperiment_1.37.0 Biobase_2.67.0
## [9] GenomicRanges_1.59.1 GenomeInfoDb_1.43.2
## [11] IRanges_2.41.2 S4Vectors_0.45.2
## [13] BiocGenerics_0.53.3 generics_0.1.3
## [15] MatrixGenerics_1.19.0 matrixStats_1.4.1
## [17] AnVIL_1.19.3 AnVILBase_1.1.0
## [19] dplyr_1.1.4 BiocStyle_2.35.0
##
## loaded via a namespace (and not attached):
## [1] jsonlite_1.8.9 magrittr_2.0.3
## [3] magick_2.8.5 GenomicFeatures_1.59.1
## [5] farver_2.1.2 rmarkdown_2.29
## [7] BiocIO_1.17.1 zlibbioc_1.53.0
## [9] vctrs_0.6.5 memoise_2.0.1
## [11] Rsamtools_2.23.1 RCurl_1.98-1.16
## [13] tinytex_0.54 rstatix_0.7.2
## [15] htmltools_0.5.8.1 S4Arrays_1.7.1
## [17] BiocBaseUtils_1.9.0 lambda.r_1.2.4
## [19] curl_6.0.1 broom_1.0.7
## [21] Formula_1.2-5 SparseArray_1.7.2
## [23] sass_0.4.9 bslib_0.8.0
## [25] htmlwidgets_1.6.4 httr2_1.0.7
## [27] zoo_1.8-12 futile.options_1.0.1
## [29] cachem_1.1.0 commonmark_1.9.2
## [31] GenomicAlignments_1.43.0 mime_0.12
## [33] lifecycle_1.0.4 pkgconfig_2.0.3
## [35] Matrix_1.7-1 R6_2.5.1
## [37] fastmap_1.2.0 GenomeInfoDbData_1.2.13
## [39] shiny_1.9.1 digest_0.6.37
## [41] colorspace_2.1-1 RaggedExperiment_1.31.1
## [43] AnnotationDbi_1.69.0 ps_1.8.1
## [45] RSQLite_2.3.9 labeling_0.4.3
## [47] filelock_1.0.3 RTCGAToolbox_2.37.0
## [49] km.ci_0.5-6 fansi_1.0.6
## [51] RJSONIO_1.3-1.9 httr_1.4.7
## [53] abind_1.4-8 compiler_4.5.0
## [55] bit64_4.5.2 withr_3.0.2
## [57] backports_1.5.0 BiocParallel_1.41.0
## [59] carData_3.0-5 DBI_1.2.3
## [61] ggsignif_0.6.4 rappdirs_0.3.3
## [63] DelayedArray_0.33.3 rjson_0.2.23
## [65] tools_4.5.0 chromote_0.3.1
## [67] httpuv_1.6.15 glue_1.8.0
## [69] restfulr_0.0.15 promises_1.3.2
## [71] gridtext_0.1.5 grid_4.5.0
## [73] gtable_0.3.6 KMsurv_0.1-5
## [75] tzdb_0.4.0 tidyr_1.3.1
## [77] websocket_1.4.2 data.table_1.16.4
## [79] hms_1.1.3 car_3.1-3
## [81] xml2_1.3.6 utf8_1.2.4
## [83] XVector_0.47.0 markdown_1.13
## [85] pillar_1.9.0 stringr_1.5.1
## [87] later_1.4.1 splines_4.5.0
## [89] ggtext_0.1.2 BiocFileCache_2.15.0
## [91] lattice_0.22-6 rtracklayer_1.67.0
## [93] bit_4.5.0.1 tidyselect_1.2.1
## [95] Biostrings_2.75.2 miniUI_0.1.1.1
## [97] knitr_1.49 gridExtra_2.3
## [99] bookdown_0.41 futile.logger_1.4.3
## [101] xfun_0.49 DT_0.33
## [103] stringi_1.8.4 UCSC.utils_1.3.0
## [105] yaml_2.3.10 evaluate_1.0.1
## [107] codetools_0.2-20 tibble_3.2.1
## [109] BiocManager_1.30.25 cli_3.6.3
## [111] xtable_1.8-4 munsell_0.5.1
## [113] processx_3.8.4 jquerylib_0.1.4
## [115] survMisc_0.5.6 Rcpp_1.0.13-1
## [117] GenomicDataCommons_1.31.0 dbplyr_2.5.0
## [119] png_0.1-8 XML_3.99-0.17
## [121] rapiclient_0.1.8 parallel_4.5.0
## [123] TCGAutils_1.27.0 readr_2.1.5
## [125] blob_1.2.4 bitops_1.0-9
## [127] scales_1.3.0 purrr_1.0.2
## [129] crayon_1.5.3 rlang_1.1.4
## [131] KEGGREST_1.47.0 rvest_1.0.4
## [133] formatR_1.14