snomedizer_options: Set SNOMED CT endpoint and other 'snomedizer' options

In ramses-antibiotics/snomedizer: R Interface to the SNOMED CT Terminology Server REST API

Set SNOMED CT endpoint and other snomedizer options

Description

Functions to get and set snomedizer default endpoint and other options

Usage

snomedizer_options_get(option.name = NULL)

snomedizer_options_set(endpoint = NULL, branch = NULL, limit = NULL)

Arguments

option.name	name of a single option to return: "endpoint", "branch", or "limit". If NULL (the default), snomedizer_options_get() returns a list of all options.
endpoint	address of a SNOMED CT Terminology Server REST API endpoint
branch	string for the branch name to use on endpoint, for instance "MAIN" for the root branch (usually the latest release of SNOMED CT's International Edition), or "MAIN/2017-07-31" for a past release. To obtain a list of all branches available on the current endpoint, see api_branch()
limit	integer for the maximum number of results to return.

Value

The factory setting of the target API parameter.

Default settings and environment variables

When loaded, the snomedizer package will look up for settings provided to the following environment variables:

SNOMEDIZER_ENDPOINT

for the endpoint. If this variable is not specified, snomedizer uses snomed_public_endpoint_suggest() to pick a public endpoint.

SNOMEDIZER_BRANCH

for the branch. If this variable is not specified, snomedizer chooses branch "MAIN" by default.

SNOMEDIZER_LIMIT

for the limit. If this variable is not specified, snomedizer sets the limit to 50 by default. The maximum is 10,000.

See Also

To learn how to set environment variables in '.Rprofile' or '.Renviron', see Startup

Other utilities: result_completeness(), result_flatten(), snomed_public_endpoint_list(), snomed_public_endpoint_suggest(), snomedizer_version_compatibility()

Examples

snomedizer_options_get()

ramses-antibiotics/snomedizer documentation built on July 12, 2022, 12:42 a.m.