get_case_lists {TCGAretriever}

Retrieve Case List Available for a Specific Cancer Study.

Description

Each study includes one or more "case lists". Each case list is a collection of samples that were analyzed using one or more platforms/assays. It is possible to obtain a list of case list identifiers from cbioportal.org for a cancer study of interest. Identifier, name, description and category are returned for each entry.

Usage

get_case_lists(csid, dryrun = FALSE)

Arguments

csid

String corresponding to the Identifier of the Study of Interest

dryrun

Logical. If TRUE, all other arguments (if any) are ignored and a representative example is returned as output. No Internet connection is required for executing the operation when 'dryrun' is TRUE.

Value

Data Frame including Case List information.

Author(s)

Damiano Fantini, [e-mail]

References

https://www.data-pulse.com/dev_site/TCGAretriever/

Examples

# Set `dryrun = FALSE` (default option) in production!
blca_case_lists <- get_case_lists("blca_tcga", dryrun = TRUE)  
blca_case_lists