list_modules: List Defined Modules.

In openscienceunil/modulr: A Dependency Injection Framework for R

Description

List defined modules.

Usage

list_modules(regexp, reserved = FALSE, wide = TRUE, full = FALSE,
  formatted = TRUE, absolute = FALSE, cols = c("name", "version",
  "storage", "along", "type", "weight", "calls", "dependencies", "uses", "size",
  "lines", "modified"))

lsmod(regexp, reserved = FALSE, wide = TRUE, full = FALSE,
  formatted = TRUE, absolute = FALSE, cols = c("name", "version",
  "storage", "along", "type", "weight", "calls", "dependencies", "uses", "size",
  "lines", "modified"))

Arguments

regexp	A regular expression. If not missing, the regular expression is used to filter the names of the modules to be made.
reserved	A flag. Should special modules with a reserved name be considered?
wide	A flag. Should the function return a data frame instead of a characted vector?
full	A flag. Should all columns be included in the data frame?
formatted	A flag. Should columns with units be string formatted?
absolute	A flag. Should the file paths be absolute?
cols	A character vector. Details returned in the columns of the data frame.

Details

For each module, the following details can be returned in the columns of the data frame:

name

name.

version

version of the module.

storage

storage of the module, 'in-memory' or 'on-disk'.

along

name of the on-disk module along which the definition takes place.

filepath

file path of the 'on-disk' module.

type

type of the object returned.

weight

memory size of the object.

calls

number of explicit make calls.

dependencies

number of direct dependencies.

uses

number of modules requiring the module.

size

memory size occupied by the definition.

lines

number of lines of the provider.

chars

number of characters of the provider.

duration

duration of the evaluation.

modified

timestamp of last modification.

created

timestamp of creation.

digest

digest (cf. get_digest).

Value

A character vector or a data frame containing module informations.

See Also

define, make, reset, and touch.

Examples

reset()
list_modules()
define("foo", NULL, function() Sys.sleep(1L))
list_modules()
list_modules(reserved = TRUE)
list_modules(reserved = TRUE, wide = FALSE)
invisible(make("foo"))
list_modules(reserved = TRUE, full = TRUE)
list_modules(
  reserved = TRUE,
  formatted = FALSE,
  cols = c("weight", "size", "modified", "created"))
define("bar", NULL, function() Sys.sleep(1L))
define("foobar", list(f = "foo", b = "bar"), function(f, b) NULL)
invisible(make("foobar"))
Sys.sleep(1L)
touch("foo")
list_modules(".oo.*", cols = c("weight", "size", "modified", "created"))

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