lookup_id: Lookup all available information on what studies a sample ID...

lookup_idR Documentation

Lookup all available information on what studies a sample ID or patient ID belongs to

Description

This is a general look up function that can take a study ID or patient ID and return what samples exist across entire cBioPortal website (depends on your base URL) that match that ID. It will return which studies include that sample or patient.

Usage

lookup_id(lookup_id = NULL, base_url = NULL)

Arguments

lookup_id

a sample ID or patient ID

base_url

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

Details

This can also be useful to see all samples a particular patient has available across all studies on cBioPortal (see also get_samples_by_patient()).

Value

A dataframe of general info for sample of patient IDs given

Examples

## Not run: 
lookup_id <- c("P-0001453-T01-IM3", "P-0000004-T01-IM3", "TCGA-OR-A5JA")
x <- lookup_id(lookup_id = lookup_id,  base_url = 'www.cbioportal.org/api')
x
 
## End(Not run)

karissawhiting/cbioportalR documentation built on Nov. 27, 2024, 6:50 a.m.