hit: Interactively Find, Make and Bind a Module.

Description Usage Arguments Details Warning See Also Examples

View source: R/make.R

Description

Interactively find, make, and bind a module.

Usage

1
2
hit(name, suffix = getOption("modulr.hit_suffix"), replace = TRUE,
  execute = FALSE)

Arguments

name

A string (character vector of lenght one).

A module name can contain letters, figures and some special characters, namely _, -, and /. The latter is a namespace separator.

Names containing /mock/, /mocks/, /test/, /tests/, /example/, or /examples/ have a special meaning related to code testing and examples.

The name "modulr" corresponds to a special module and is therefore reserved.

suffix

A string (character vector of lenght one). Suffix added to variable names.

replace

A flag. Should existing bindings be replaced?

execute

A flag. Should binding be automatically made?

Details

See make and module_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

make.

Examples

1
2
3
4
"foobar" %provides% "Hello World"
"foo" %provides% "Hello"
## Not run: hit("foo")
## Not run: hit(foo)

openscienceunil/modulr documentation built on May 3, 2019, 5:49 p.m.