accessRelation: Search relation in CEDAR

In earnaud/cedarr: Bio Ontology R API Access

Search relation in CEDAR

Description

Find provisional relation by id. DISCLAIMER: at current development stage of the API, this function is not operational (empty content) !

Usage

accessRelation(api.key, id, 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)
id	character. Provisional relation short identifier.
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")

Details

DISCLAIMER: at current development stage of the API, this function is not operational !

This function matches the following queries from the Swagger UI (https://terminology.metadatacenter.org/api/#/):

• /relations/{id}

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.

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