SpaDES (version 1.2.0)

moduleMetadata: Parse and extract module metadata

Description

Parse and extract module metadata

Usage

moduleMetadata(module, path)
"moduleMetadata"(module, path)
"moduleMetadata"(module)

Arguments

module

Character string. Your module's name.

path

Character string specifying the file path to modules directory. Default is the current working directory.

Value

A list of module metadata, matching the structure in defineModule.

See Also

defineModule

Examples

  path <- system.file(package = "SpaDES", "sampleModules")
  sampleModules <- dir(path)
  x <- moduleMetadata(sampleModules[1], path)