.section

helper function which creates a section consisting of header and content in a markdown document
and skips section when content is empty

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

Falk Benke

.section function

<dl><dt>data</dt>
<dd>a character vector to be written to the markdown document</dd>
<dt>zz</dt>
<dd>a connection object of class "textConnection" containing the markdown document</dd>
<dt>title</dt>
<dd>the title to be used (character vector of length 1)</dd>
<dt>level</dt>
<dd>level of the heading (1 means main header, higher numbers reflect lower levels)</dd>
<dt>id</dt>
<dd>ID given to the title (relevant for anchors)</dd></dl>

Arguments

Author

.section — .section

<dl>

<dt>data</dt>
<dd>a character vector to be written to the markdown document</dd>


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


<dt>title</dt>
<dd>the title to be used (character vector of length 1)</dd>


<dt>level</dt>
<dd>level of the heading (1 means main header, higher numbers reflect lower levels)</dd>


<dt>id</dt>
<dd>ID given to the title (relevant for anchors)</dd>

</dl>

.section: .section

Description

Usage

Arguments

Author

See Also