Skip to contents

Get Metadata on All Available Studies in a Database

Usage

available_studies(base_url = NULL)

Arguments

base_url

The database URL to query. If NULL will default to URL set with set_cbioportal_db(<your_db>)

Value

A dataframe of available studies and their metadata

Examples

# \dontrun{
set_cbioportal_db("public")
#>  You are successfully connected!
#>  base_url for this R session is now set to "www.cbioportal.org/api" 
available_studies()
#> # A tibble: 397 × 13
#>    studyId name  description publicStudy groups status importDate allSampleCount
#>    <chr>   <chr> <chr>       <lgl>       <chr>   <int> <chr>               <int>
#>  1 acc_tc… Adre… "TCGA Adre… TRUE        PUBLIC      0 2023-06-1…             92
#>  2 laml_t… Acut… "TCGA Acut… TRUE        PUBLIC      0 2023-06-1…            200
#>  3 blca_t… Blad… "TCGA Blad… TRUE        PUBLIC      0 2023-06-1…            413
#>  4 kirc_t… Kidn… "TCGA Kidn… TRUE        PUBLIC      0 2023-06-1…            538
#>  5 cesc_t… Cerv… "TCGA Cerv… TRUE        PUBLIC      0 2023-06-1…            310
#>  6 chol_t… Chol… "TCGA Chol… TRUE        PUBLIC      0 2023-06-1…             51
#>  7 kich_t… Kidn… "TCGA Kidn… TRUE        PUBLIC      0 2023-06-1…            113
#>  8 coadre… Colo… "TCGA Colo… TRUE        PUBLIC      0 2023-06-1…            640
#>  9 dlbc_t… Lymp… "TCGA Lymp… TRUE        PUBLIC      0 2023-06-1…             48
#> 10 esca_t… Esop… "TCGA Esop… TRUE        PUBLIC      0 2023-06-1…            186
#> # ℹ 387 more rows
#> # ℹ 5 more variables: readPermission <lgl>, cancerTypeId <chr>,
#> #   referenceGenome <chr>, pmid <chr>, citation <chr>
# }