pkgmaker: setupPackageOptions – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

setupPackageOptions

Package Specific Options

The following functions to access/set the options from the set are assigned in envir:

setupPackageOptions(
  ...,
  NAME = NULL,
  ENVIR = topenv(parent.frame()),
  RESET = isLoadingNamespace()
)

`...`	a single named list or named arguments that provide the default options and their values.
`NAME`	name of the set of options. This is used as a prefix for the name of the associated global option: `package:<name>`.
`ENVIR`	environment where the option wrapper functions will be defined. No function is defined if `ENVIR=NULL`
`RESET`	a logical that indicates whether the option set should overwrite one that already exists if necessary. The default is `FALSE` (i.e. no reset), except when loading a namespace, either from an installed package or a development package – with devtools. If `FALSE`, an error is thrown if trying to setup options with the same name.

Development Utilities for R Packages

v0.32.2

GPL (>= 2)

Authors

Renaud Gaujoux [aut, cre]

Initial release

2020-10-20