cb_query {TCGAretriever} | R Documentation |
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, damiano.fantini@gmail.com
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)
[Package TCGAretriever version 1.9.1 Index]