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

In waldronlab/oncoKBData: A package to access the oncoKB web API

A class for representing the oncoKB API protocol

Description

The oncoKB class is a representation of the oncoKB 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 'oncoKB'
operations(x, ..., .deprecated = FALSE)

Arguments

x	A Service instance or API representation as given by the oncoKB 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.oncoKB.org/api/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 oncoKB 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

An oncoKB class instance.

Functions

• operations(oncoKB):

Slots

api_header

⁠named character()⁠ vector passed on to the .headers argument in add_headers()

See Also

oncoKB, Service

Examples

oncoKB()

waldronlab/oncoKBData documentation built on Oct. 11, 2024, 2:02 p.m.