options (version 0.3.0)

get_options_env: Retrieve options environment (experimental)

Description

The options environment stores metadata regarding the various options defined in the local scope - often the top environment of a package namespace.

Usage

get_options_env(env, ...)
# S3 method for options_env
get_options_env(env, ...)
# S3 method for options_list
get_options_env(env, ...)
# S3 method for default
get_options_env(
  env = parent.frame(),
  ...,
  inherits = FALSE,
  ifnotfound = emptyenv()
)

Value

An environment containing option specifications and default values, or ifnotfound if no environment is found.

Arguments

env

An environment in which to search for an options environment

...

Additional arguments unused

inherits

Whether to search upward through parent environments

ifnotfound

A result to return of no options environment is found.