R/moduleMetadata.R
moduleParamsInputsOuputs.Rd
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
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)
Character string. Your module's name.
Character string specifying the file path to modules directory.
Default is to use the spades.modulePath
option.
data.frame
if (FALSE) {
## easily include these tables in Rmd files using knitr
path <- system.file("sampleModules", package = "SpaDES.core")
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)
}