listValueSets: List value sets and value sets collections

In earnaud/cedarr: Bio Ontology R API Access

List value sets and value sets collections

Description

Find all value sets or value sets collections.

Usage

listValueSets(api.key, output.mode = "content")

listVSCollections(api.key, 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)
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

An exhaustive list of value sets for any value set collection.

An exhaustive list of the VS collections in CEDAR.

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.

Functions

• listVSCollections:

Examples

## Not run: 
my.api.key <- readline()

result1 <- cedarr::listValueSets(
  my.api.key
)

View(result1)

## End(Not run)

## Not run: 
my.api.key <- readline()

result2 <- cedarr::listVSCollections(
  my.api.key,
)

View(result2)

## End(Not run)

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