cedar.get: CEDAR HTTP get method

In earnaud/cedarr: Bio Ontology R API Access

CEDAR HTTP get method

Description

Internal function wrapping the GET method.

Usage

cedarGet(api.key, url, ..., output.mode = "content")

Arguments

api.key	character. An API Key is required to access any API call. It is used within cedarr as a header for http requests. An API key is linked to a CEDAR account (https://cedar.metadatacenter.org/profile).
url	character. An URL to the CEDAR resource to query data from.
...	arguments to input in the request body.
output.mode	character. "full" will return the whole response object (from httr) or "content" will fetch the interest values from the response object. Getting the whole object might be interesting to have a look at system metadata, or in case of error to debug the connection. (defaults to "content")

Value

If output.mode = "full", the whole http response object (see httr::response). It is structured as a list with response metadata wrapping the content item which contains the wanted result.

If output.mode = "content", the content item is directly returned, containing database metadata and the interesting information in the collection subitem.

For examples, see access*() functions from this package.

earnaud/cedarr documentation built on Oct. 25, 2022, 6:27 a.m.