createListModularCode {goxygen}

createListModularCode

Description

support function to create documentation of modular GAMS code.

Usage

createListModularCode(
  cc,
  interfaces,
  path = ".",
  citation = NULL,
  unitPattern = c("\\(", "\\)"),
  includeCore = FALSE,
  mainfile = "main.gms",
  docfolder = "doc"
)

Arguments

cc

codeCheck information

interfaces

interface information

path

path to the model to be documented

citation

citation data read from a CFF file

unitPattern

pattern that is usedto identify the unit in the description, default =c("\(","\)")

includeCore

Boolean whether core should be included or not, default=FALSE

mainfile

main file of the model

docfolder

folder the documentation should be written to relative to model folder

Author(s)

Jan Philipp Dietrich

See Also

codeCheck