Get All Sample Lists Available For a Study

Usage

available_sample_lists(study_id = NULL, base_url = NULL)

Arguments

study_id: A character string indicating which study ID should be searched. Only 1 study ID allowed.
base_url: The database URL to query If NULL will default to URL set with set_cbioportal_db(<your_db>)

Value

A dataframe of patient_ids in a given study

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_sample_lists(study_id = "acc_tcga")
#> # A tibble: 9 × 5
#>   category                                name  description sampleListId studyId
#>   <chr>                                   <chr> <chr>       <chr>        <chr>  
#> 1 all_cases_with_mrna_rnaseq_data         Samp… Samples wi… acc_tcga_rn… acc_tc…
#> 2 all_cases_in_study                      All … All sample… acc_tcga_all acc_tc…
#> 3 all_cases_with_cna_data                 Samp… Samples wi… acc_tcga_cna acc_tc…
#> 4 all_cases_with_mutation_and_cna_data    Samp… Samples wi… acc_tcga_cn… acc_tc…
#> 5 all_cases_with_mutation_and_cna_and_mr… Comp… Samples wi… acc_tcga_3w… acc_tc…
#> 6 all_cases_with_methylation_data         Samp… Samples wi… acc_tcga_me… acc_tc…
#> 7 all_cases_with_methylation_data         Samp… Samples wi… acc_tcga_me… acc_tc…
#> 8 all_cases_with_rppa_data                Samp… Samples pr… acc_tcga_rp… acc_tc…
#> 9 all_cases_with_mutation_data            Samp… Samples wi… acc_tcga_se… acc_tc…
# }