cBioPortal-class: A class for representing the cBioPortal API protocol

In waldronlab/cBioPortalData: Exposes and Makes Available Data from the cBioPortal Web Resources

A class for representing the cBioPortal API protocol

Description

The cBioPortal class is a representation of the cBioPortal API protocol that directly inherits from the Service class in the AnVIL package. For more information, see the AnVIL package.

Usage

## S4 method for signature 'cBioPortal'
operations(x, ..., .deprecated = FALSE)

Arguments

x	A AnVIL instance or API representation as given by the cBioPortal function.
...	additional arguments passed to methods or, for ⁠operations,Service-method⁠, to the internal get_operation() function.
.deprecated	optional logical(1) include deprecated operations?

Details

This class takes the static API as provided at https://www.cbioportal.org/api/v2/api-docs and creates an R object with the help from underlying infrastructure (i.e., rapiclient and AnVIL) to give the user a unified representation of the API specification provided by the cBioPortal group. Users are not expected to interact with this class other than to use it as input to the functionality provided by the rest of the package.

Value

A cBioPortal class instance

Functions

• operations(cBioPortal):

See Also

cBioPortal, AnVIL

Examples

cBioPortal()

waldronlab/cBioPortalData documentation built on Dec. 14, 2024, 6:50 p.m.