.header

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

the title to be used (character vector of length 1)

title

level of the heading (1 means main header, higher numbers reflect lower levels)

level

ID given to the title (relevant for anchors)

helper function which writes a title for a markdown section

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

.header function

<dl><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

.header — .header

<dl>

<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>

.header: .header

Description

Usage

Arguments

Author

See Also