get_options_env: Retrieve options environment (experimental)

In options: Simple, Consistent Package Options

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 class 'options_env'
get_options_env(env, ...)

## S3 method for class 'options_list'
get_options_env(env, ...)

## Default S3 method:
get_options_env(
  env = parent.frame(),
  ...,
  inherits = FALSE,
  ifnotfound = emptyenv()
)

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.

Value

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

Note

This function's public interface is still under consideration. It is surfaced to provide access to option names, though the exact mechanism of retrieving these names should be considered experimental.

options documentation built on April 4, 2025, 3:07 a.m.