available_patients {cbioportalR}

R Documentation

Get All Patient IDs in a Study

Description

Get All Patient IDs in a Study

Usage

available_patients(study_id = NULL, base_url = NULL)

Arguments

study_id	A character string indicating which study ID should be searched. Only 1 study allowed. If NULL, we will guess a default study ID based on your database URL.
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

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

## End(Not run)

---