btGet-methods: Get items from BioThings APIs

Description Usage Arguments Value Examples

Description

Use gene, taxon, variant, chemical and other IDs to get annotation information from BioThings APIs.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
btGet(biothings, ids, fields, ..., return.as = "records")

## S4 method for signature 'BioThingsClient'
btGet(biothings, ids, fields, ...,
  return.as = "records")

## S4 method for signature 'character'
btGet(biothings, ids, fields, ...,
  return.as = "records")

## S4 method for signature 'missing'
btGet(biothings, ids, fields, ..., return.as = "records")

Arguments

biothings

BioThings object or character .

ids

character.

fields

Specify fields to receive from API

...

Other parameters to pass to API

return.as

character.

Value

The API response in the form of the provided argument return.as

Examples

1
2
3
4
#Equivalent:

btGet("gene", "1017", fields = c("symbol","name","taxid","entrezgene"),
      return.as = "text")

biothings/biothings_client.R documentation built on Jan. 12, 2018, 7:56 a.m.