ctxR_options: ctxR Options

In ctxR: Utilities for Interacting with the 'CTX' APIs

ctxR Options

Description

ctxR stores options as a named list in R's global options, i.e. getOption('ctxR'). It currently stores two such options, one for CCTE credentialing and one to suppress private API information in the URLs printed to the screen when web queries are placed. For both of those, see register_ctx_api_key().

Usage

set_ctxR_option(...)

has_ctxR_options()

has_ctxR_option(option)

Arguments

...	a named listing of options to set
option	a specific option to query, e.g. display_api_key

Value

• set_ctxR_option() does not have a return value but has the side effect of setting options used by other functions.

• has_ctxR_option() returns a Boolean.

• has_ctxR_options() returns a Boolean.

See Also

register_ctx_api_key()

Examples

# Set ctxR options
set_ctxR_option('display_api_key' = FALSE)


# Check if there are options registered to 'ctxR'
has_ctxR_options()


# Check if a specific option is registered for 'ctxR'
has_ctxR_option('display_api_key')

ctxR documentation built on April 12, 2025, 2:07 a.m.