support function to create documentation of modular GAMS code.
createListModularCode(
cc,
interfaces,
path = ".",
citation = NULL,
unitPattern = c("\\(", "\\)"),
includeCore = FALSE,
mainfile = "main.gms",
docfolder = "doc",
startType = "equations"
)codeCheck information
interface information
path to the model to be documented
citation data read from a CFF file
pattern that is usedto identify the unit in the description, default =c("\(","\)")
Boolean whether core should be included or not, default=FALSE
main file of the model
folder the documentation should be written to relative to model folder
input parameter for extractDocumentation to be passed
when extracting documentation from realizations. Defaults to "equations",
meaning that documentation in realizations should be interpreted as equations
documentation, if no identifier is set.
Jan Philipp Dietrich
codeCheck