oncoKB: The R interface to the oncoKB API Data Service

In LiNk-NY/oncoKBData: A package to access the oncoKB web API

The R interface to the oncoKB API Data Service

Description

This section of the documentation lists the functions that allow users to access the oncoKB API. The main representation of the API can be obtained from the oncoKB function. The supporting functions listed here give access to specific parts of the API and allow the user to explore the API with individual calls.

Usage

oncoKB(
  hostname = "www.oncokb.org",
  protocol = "https",
  api. = .DEMO_ENDPOINT,
  token = character()
)

Arguments

hostname	character(1) The internet location of the service (default: 'www.cbioportal.org')
protocol	character(1) The internet protocol used to access the hostname (default: 'https')
api.	character(1) The directory location of the API protocol within the hostname (default: '/api/api-docs')
token	character(1) The Authorization Bearer token e.g., "63eba81c-2591-4e15-9d1c-fb6e8e51e35d" or a path to text file.

Value

oncoKB: An API object of class 'oncoKB'

Examples

oncokb <- oncoKB()

## Authorization: Bearer token as a file
if (interactive())
  oncoKB(token = "~/onco_token.txt")

names(operations(oncokb))

LiNk-NY/oncoKBData documentation built on April 30, 2024, 3:57 p.m.