available_samples {cbioportalR}

Get All Sample IDs in a Study

Description

Pulls all available sample IDs for a given study ID or sample list ID. Either a study ID or sample list ID must be passed. If both sample_list and study_id are not NULL, sample_list ID will be searched and study_id will be ignored.

Usage

available_samples(study_id = NULL, sample_list_id = NULL, base_url = NULL)

Arguments

study_id

A character string indicating which study ID should be searched. Only 1 study ID allowed.

sample_list_id

A character string indicating which sample list ID should be searched. Only 1 sample list 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 sample_ids in a given study

Examples

## Not run: 
set_cbioportal_db("public")
available_samples(study_id = "acc_tcga")
available_samples(sample_list_id = "acc_tcga_cna")

## End(Not run)