List Defined Modules.

List defined modules.

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.

Value

A character vector or a data frame containing module informations.

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).

See also

define, make, reset, and touch.

Examples

reset()
#> [2017-06-21T21:58:23 UTC] Resetting modulr state ... OK
list_modules()
define("foo", NULL, function() Sys.sleep(1L))
#> [2017-06-21T21:58:23 UTC] Defining 'foo' ... OK
list_modules()
#>   name version   storage along type weight calls dependencies uses   size lines
#> 1  foo    <NA> in-memory  <NA> <NA>   <NA>     0            0    0 1.1 Kb     2
#>                  modified
#> 1 2017-06-21T21:58:23 UTC
list_modules(reserved = TRUE)
#>                name    version   storage along type weight calls dependencies
#> 1               foo       <NA> in-memory  <NA> <NA>   <NA>     0            0
#> 2 modulr#0.1.7.9186 0.1.7.9186 in-memory  <NA> <NA>   <NA>     0            0
#>   uses   size lines                modified
#> 1    0 1.1 Kb     2 2017-06-21T21:58:23 UTC
#> 2    0 116 Kb    66 2017-06-21T21:58:23 UTC
list_modules(reserved = TRUE, wide = FALSE)
#> [1] "foo"               "modulr#0.1.7.9186"
invisible(make("foo"))
#> [2017-06-21T21:58:23 UTC] Making 'foo' ...
#> [2017-06-21T21:58:23 UTC] * Visiting and defining dependencies ...
#> [2017-06-21T21:58:23 UTC] * Constructing dependency graph ... OK
#> [2017-06-21T21:58:24 UTC] DONE ('foo' in 1 secs)
list_modules(reserved = TRUE, full = TRUE)
#>                name    version   storage filepath  url along type  weight calls
#> 1               foo       <NA> in-memory     <NA> <NA>  <NA> NULL 0 bytes     1
#> 2 modulr#0.1.7.9186 0.1.7.9186 in-memory     <NA> <NA>  <NA> <NA>    <NA>     0
#>   dependencies uses   size lines chars                 created
#> 1            0    0 1.1 Kb     2    25 2017-06-21T21:58:23 UTC
#> 2            0    0 116 Kb    66  3165 2017-06-21T21:58:23 UTC
#>                  modified duration           digest
#> 1 2017-06-21T21:58:24 UTC 1.000267 a7a826f201a387b4
#> 2 2017-06-21T21:58:23 UTC       NA 74a025959c822597
list_modules(
  reserved = TRUE,
  formatted = FALSE,
  cols = c("weight", "size", "modified", "created"))
#>                name weight   size            modified             created
#> 1               foo      0   1104 2017-06-21 21:58:24 2017-06-21 21:58:23
#> 2 modulr#0.1.7.9186   <NA> 118744 2017-06-21 21:58:23 2017-06-21 21:58:23
define("bar", NULL, function() Sys.sleep(1L))
#> [2017-06-21T21:58:24 UTC] Defining 'bar' ... OK
define("foobar", list(f = "foo", b = "bar"), function(f, b) NULL)
#> [2017-06-21T21:58:24 UTC] Defining 'foobar' ... OK
#> Warning: [2017-06-21T21:58:24 UTC] Possibly 2 unused dependencies: ‘f’, ‘b’.
invisible(make("foobar"))
#> [2017-06-21T21:58:24 UTC] Making 'foobar' ...
#> [2017-06-21T21:58:24 UTC] * Visiting and defining dependencies ...
#> [2017-06-21T21:58:24 UTC] * Constructing dependency graph ... OK
#> [2017-06-21T21:58:24 UTC] * Sorting 2 dependencies with 2 relations ... on 1 layer, OK
#> [2017-06-21T21:58:24 UTC] * Evaluating new and outdated dependencies ...
#> [2017-06-21T21:58:24 UTC] ** Evaluating #1/2 (layer #1/1): 'bar' ...
#> [2017-06-21T21:58:25 UTC] DONE ('foobar' in 1 secs)
Sys.sleep(1L)
touch("foo")
#> [2017-06-21T21:58:26 UTC] Touching 'foo' ... OK
list_modules(".oo.*", cols = c("weight", "size", "modified", "created"))
#>     name  weight   size                modified                 created
#> 1    foo    <NA> 1.1 Kb 2017-06-21T21:58:26 UTC 2017-06-21T21:58:23 UTC
#> 2 foobar 0 bytes 1.2 Kb 2017-06-21T21:58:25 UTC 2017-06-21T21:58:24 UTC