module {mod}

Make a Module

Description

Institute a module object inline or from a file. mod::ule() is a useful shorthand for module() when this package is not attached.

Usage

module(..., parent = parent.frame(), lock = TRUE,
  expose_private = FALSE)

ule(..., parent = parent.frame(), lock = TRUE,
  expose_private = FALSE)

acquire(module, parent = baseenv(), lock = TRUE,
  expose_private = FALSE)

Arguments

...

module expression

parent

the enclosing environment

lock

lock the environment; logical

expose_private

expose the private environment as '..private..'; logical

module

module object, or path to a module file

Value

an environment of class module containing defined objects

Examples

# from file
module_path <- system.file("misc", "example_module.R", package = "mod")
example_module <- acquire(module_path)

example_module$e(123)

# inline
my_module <- mod::ule({
    a <- 1
    .a <- 2
    f <- function(){.a}
})

my_module$a
my_module$f