SpaDES.core (version 2.0.5)

moduleParams: Extract a module's parameters, inputs, or outputs

Description

These are more or less wrappers around moduleMetadata, with the exception that extraneous spaces and End-Of-Line characters will be removed from the desc arguments in defineParameters, defineInputs, and defineOutputs

Usage

moduleParams(module, path)
# S4 method for character,character
moduleParams(module, path)
moduleInputs(module, path)
# S4 method for character,character
moduleInputs(module, path)
moduleOutputs(module, path)
# S4 method for character,character
moduleOutputs(module, path)

Value

data.frame

Arguments

module

Character string. Your module's name.

path

Character string specifying the file path to modules directory. Default is to use the spades.modulePath option.

Author

Alex Chubaty

See Also

moduleMetadata()

Examples

# \donttest{
## easily include these tables in Rmd files using knitr
path <- getSampleModules(tempdir())
sampleModules <- dir(path)

p <- moduleParams(sampleModules[3], path = path)
i <- moduleInputs(sampleModules[3], path = path)
o <- moduleOutputs(sampleModules[3], path = path)

knitr::kable(p)
knitr::kable(i)
knitr::kable(o)
# }