Package: options 0.3.0

options: Simple, Consistent Package Options

Simple mechanisms for defining and interpreting package options. Provides helpers for interpreting environment variables, global options, defining default values and more.

Authors:Doug Kelkhoff [aut, cre]

options_0.3.0.tar.gz
options_0.3.0.zip(r-4.5)options_0.3.0.zip(r-4.4)options_0.3.0.zip(r-4.3)
options_0.3.0.tgz(r-4.4-any)options_0.3.0.tgz(r-4.3-any)
options_0.3.0.tar.gz(r-4.5-noble)options_0.3.0.tar.gz(r-4.4-noble)
options_0.3.0.tgz(r-4.4-emscripten)options_0.3.0.tgz(r-4.3-emscripten)
options.pdf |options.html
options/json (API)
NEWS

# Install 'options' in R:
install.packages('options', repos = c('https://dgkf.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://codeberg.org/dgkf/options

On CRAN:

developer-tools

8.84 score 25 stars 1 packages 1.0k scripts 815 downloads 26 exports 0 dependencies

Last updated 1 months agofrom:266af87306. Checks:OK: 1 ERROR: 3 NOTE: 3. Indexed: yes.

TargetResultDate
Doc / VignettesOKNov 16 2024
R-4.5-winNOTENov 16 2024
R-4.5-linuxERRORNov 16 2024
R-4.4-winNOTENov 16 2024
R-4.4-macERRORNov 16 2024
R-4.3-winNOTENov 16 2024
R-4.3-macERRORNov 16 2024

Exports:as_paramsas_roxygen_docsdefine_optiondefine_optionsenvvar_choice_ofenvvar_evalenvvar_eval_or_rawenvvar_isenvvar_is_falseenvvar_is_one_ofenvvar_is_setenvvar_is_trueenvvar_name_defaultenvvar_name_genericenvvar_str_splitget_options_envoptopt_setopt_sourceopt<-option_name_defaultoption_specoptsopts_listset_envvar_name_fnset_option_name_fn

Dependencies:

Environment Variables

Rendered fromenvvars.Rmdusingknitr::rmarkdownon Nov 16 2024.

Last update: 2022-12-22
Started: 2022-12-22

options

Rendered fromoptions.Rmdusingknitr::rmarkdownon Nov 16 2024.

Last update: 2022-12-22
Started: 2022-12-22

Readme and manuals

Help Manual

Help pageTopics
Produce @param roxygen sections for optionsas_params
Generate Standalone '?options' Documentationas_roxygen_docs
Defining Optionsdefine_option define_options defining_options
Generator functions for environment variable processorsenvvar_choice_of envvar_eval envvar_eval_or_raw envvar_fns envvar_is envvar_is.character envvar_is.logical envvar_is.NULL envvar_is.numeric envvar_is_false envvar_is_one_of envvar_is_set envvar_is_true envvar_str_split
Retrieve options environment (experimental)get_options_env get_options_env.default get_options_env.options_env get_options_env.options_list
Define Naming Conventionsnaming set_envvar_name_fn set_option_name_fn
Naming Convention Formattersenvvar_name_default envvar_name_generic naming_formats option_name_default
Inspecting Option Valuesopt opt<- opts opts_list opt_set opt_set_local opt_source
Specify Optionoption_spec