cb_query: Core Query Engine

In dami82/TCGAretriever: Retrieve Genomic and Clinical Data from CBioPortal Including TCGA Data

Core Query Engine

Description

Submit a query by getting or posting to the URL provided as argument (typically a cbioportal.org URL). The function attempts the same query recursively until the content has been completely downloaded. If 'body' is NULL, the query is submitted via GET. Otherwise, the query is submitted via POST.

Usage

cb_query(my_url, body = NULL)

Arguments

my_url	String. The URL pointing to the cBioPortal API.
body	String. Parameters to be passed via POST to the query URL. Can be NULL.

Details

This is a core function invoked by other functions in the package.

Value

Data.frame including data retrieved from cBioPortal.

Author(s)

Damiano Fantini, [e-mail]

References

https://www.data-pulse.com/dev_site/TCGAretriever/

Examples

# The example below requires an active Internet connection.
## Not run: 
my_url <- "https://www.cbioportal.org/api/studies"
x <- TCGAretriever:::cb_query(my_url)

## End(Not run)
 

dami82/TCGAretriever documentation built on Feb. 2, 2024, 12:06 p.m.