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.
Examples
oncokb <- oncoKB()
## Authorization: Bearer token as a file
if (interactive())
oncoKB(token = "~/onco_token.txt")
names(operations(oncokb))
#> [1] "annotateCopyNumberAlterationsGetUsingGET_1"
#> [2] "annotateCopyNumberAlterationsPostUsingPOST_1"
#> [3] "annotateMutationsByGenomicChangeGetUsingGET_1"
#> [4] "annotateMutationsByGenomicChangePostUsingPOST_1"
#> [5] "annotateMutationsByHGVSgGetUsingGET_1"
#> [6] "annotateMutationsByHGVSgPostUsingPOST_1"
#> [7] "annotateMutationsByProteinChangeGetUsingGET_1"
#> [8] "annotateMutationsByProteinChangePostUsingPOST_1"
#> [9] "annotateStructuralVariantsGetUsingGET_1"
#> [10] "annotateStructuralVariantsPostUsingPOST_1"
#> [11] "infoGetUsingGET_1"
#> [12] "levelsGetUsingGET_1"
#> [13] "levelsDiagnosticGetUsingGET_1"
#> [14] "levelsPrognosticGetUsingGET_1"
#> [15] "levelsResistanceGetUsingGET_1"
#> [16] "levelsSensitiveGetUsingGET_1"
#> [17] "utilsAllCuratedGenesGetUsingGET_1"
#> [18] "utilsAllCuratedGenesTxtGetUsingGET_1"
#> [19] "utilsCancerGeneListGetUsingGET_1"
#> [20] "utilsCancerGeneListTxtGetUsingGET_1"