options_provider: Module Options Provider

In aclemen1/modulr: A Dependency Injection Framework for R

Module Options Provider

Description

Construct a module provider intended for defining modules that can be used as general purpose options and configuration containers.

Usage

options_provider(...)

Arguments

...	Named arguments used as default options. If void, no default option is set.

Value

A module provider which exposes an R environment. The default options arguments, if any, are used to assign the values to their corresponding names in the returned environment.

Syntactic Sugars

name %provides_options% options

Warning

It is considered a very bad practice to define, touch, undefine, load, make, reset, or perform any other operation from within a module definition that may alterate the internal state of modulr.

See Also

%<=%, define, make, %provides%, %requires%, reset, and touch.

Examples

reset()

"foo/config" %provides% options_provider(upper = FALSE)

"foo" %requires% list(config = "foo/config") %provides% {
  function() casefold("foo", upper = config$upper)
}

foo %<=% "foo"
foo()

config %<=% "foo/config"
config$upper <- TRUE
foo()

"foo/config" %provides_options% list(upper = FALSE)
foo %<=% "foo"
foo()

touch("foo/config")
"foo/config" %provides_options% list(upper = FALSE)
foo %<=% "foo"
foo()

aclemen1/modulr documentation built on Oct. 2, 2024, 7:18 a.m.