.interfaceplot

a connection object of class "textConnection" containing the markdown document

Name of the module for which the interfaceplot should be shown

name

folder the documentation should be written to relative to model folder

docfolder

helper function which includes interface plot figures in a markdown document, if available.
The figures need to be created beforehand.

A collection of tools which extract a model documentation from 'GAMS' code and comments.
In order to use the package you need to install 'pandoc' and 'pandoc-citeproc'
first (<https://pandoc.org/>).

Jan Dietrich

goxygen

In-Code Documentation for 'GAMS'

Jan Philipp Dietrich

Kristine Karstens

David Klein

Lavinia Baumstark

.interfaceplot function

<dl><dt>zz</dt>
<dd>a connection object of class "textConnection" containing the markdown document</dd>
<dt>name</dt>
<dd>Name of the module for which the interfaceplot should be shown</dd>
<dt>docfolder</dt>
<dd>folder the documentation should be written to relative to model folder</dd></dl>

Arguments

Author

.interfaceplot — .interfaceplot

<dl>

<dt>zz</dt>
<dd>a connection object of class "textConnection" containing the markdown document</dd>


<dt>name</dt>
<dd>Name of the module for which the interfaceplot should be shown</dd>


<dt>docfolder</dt>
<dd>folder the documentation should be written to relative to model folder</dd>

</dl>

.interfaceplot: .interfaceplot

Description

Usage

Arguments

Author

See Also