cBioDataPack: Obtain pre-packaged data from cBioPortal and represent as a...

In cBioPortalData: Exposes and makes available data from the cBioPortal web resources

Description

The cBioDataPack function allows the user to download and process cancer study datasets found in MSKCC's cBioPortal. Output datasets use the MultiAssayExperiment data representation to faciliate analysis and data management operations.

Usage

cBioDataPack(
  cancer_study_id,
  use_cache = TRUE,
  names.field = c("Hugo_Symbol", "Entrez_Gene_Id", "Gene"),
  ask = TRUE
)

Arguments

cancer_study_id	character(1) The study identifier from cBioPortal as in https://cbioportal.org/webAPI
use_cache	logical(1) (default TRUE) create the default cache location and use it to track downloaded data. If data found in the cache, data will not be re-downloaded. A path can also be provided to data cache location.
names.field	A character vector of possible column names for the column that is used to label ranges from a mutations or copy number file.
ask	A logical vector of length one indicating whether to prompt the the user before downloading and loading study MultiAssayExperiment. If TRUE, the user will be prompted to continue for studies that are not currently building as MultiAssayExperiment based on previous testing (in a non-interactive session, no data will be downloaded and built unless ask = FALSE).

Details

The list of datasets can be found in the studiesTable dataset by doing data("studiesTable"). Some datasets may not be available for download and are not guaranteed to be represented as MultiAssayExperiment data objects. After taking a random sample of 100 (using set.seed(1234)), we were able to succesfully represent about 76 percent of the study identifiers as MultiAssayExperiment objects. Please refer to the #' website for the full list of available datasets. Users who would like to prioritize particular datasets should open GitHub issues at the URL in the DESCRIPTION file. For a more fine-grained approach to downloading data from the cBioPortal API, refer to the cBioPortalData function.

Value

A MultiAssayExperiment object

cBio_URL

The cBioDataPack function accesses data from the cBio_URL option. By default, it points to an Amazon S3 bucket location. Previously, it pointed to 'http://download.cbioportal.org'. This recent change (> 2.1.17) should provide faster and more reliable downloads for all users. See the URL using cBioPortalData:::.url_location. This can be changed if there are mirrors that host this data by setting the cBio_URL option with getOption("cBio_URL", "https://some.url.com/") before running the function.

Author(s)

Levi Waldron, Marcel R., Ino dB.

See Also

https://www.cbioportal.org/datasets, cBioPortalData

Examples

data(studiesTable)

head(studiesTable[["cancer_study_id"]])

# ask=FALSE for non-interactive use
mae <- cBioDataPack("acc_tcga", ask = FALSE)

cBioPortalData documentation built on April 17, 2021, 6:07 p.m.