options_env {options}R Documentation

Options Environment Class

Description

The options environment stores primarily, the default values for options. In addition, it stores metadata pertaining to each option in the form of attributes.

Usage

options_initialized(env, inherits = FALSE)

init_options_env(env = parent.frame())

as_options_list(x, ...)

## S3 method for class 'list'
as_options_list(x, ...)

## S3 method for class 'options_env'
as_options_list(x, ...)

get_option_default_value(x, env = parent.frame())

get_options_spec(env = parent.frame())

get_option_spec(
  name,
  env = parent.frame(),
  inherits = FALSE,
  on_missing = warning
)

set_option_spec(name, details, env = parent.frame())

Arguments

env

An environment in which to search for an options environment

inherits

Whether to search upward through parent environments

...

Additional arguments unused

Functions

Attributes


[Package options version 0.2.0 Index]