get_dependencies: Get the Dependencies of a Module.

Description Usage Arguments Value Warning See Also Examples

View source: R/define.R

Description

Get the list of declared dependencies of a module.

Usage

1

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.

load

A flag. Should an undefined module be implicitely loaded?

Value

A list of dependencies.

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, reset, and root_config.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
reset()
define("foo", NULL, function() "foo")
define("bar", list(foo = "foo"), function(foo) paste0(foo, "bar"))
define("bar/mock", get_dependencies("bar"), function(foo) paste0(foo, "baz"))
make("bar/mock")

reset()
tmp_dir <- tempfile("modulr_")
dir.create(tmp_dir)
cat('define("foo", NULL, function() "Hello")',
 file = file.path(tmp_dir, "foo.R"))
cat('define("bar", list(foo = "foo"), function() paste(foo, "World!"))',
 file = file.path(tmp_dir, "bar.R"))
root_config$set(tmp_dir)
## Not run: get_dependencies("bar", load = FALSE)
get_dependencies("bar", load = TRUE)
unlink(tmp_dir, recursive = TRUE)

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