SpaDES (version 1.1.4)

moduleMetadata: Parse and extract module metadata

Description

Parse and extract module metadata

Usage

moduleMetadata(module, path)
## S3 method for class 'character,character':
moduleMetadata(module, path)
## S3 method for class 'character,missing':
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)