nldoc_write_nldoc

internal

Setup, run and analyze 'NetLogo' (<https://ccl.northwestern.edu/netlogo/>) model simulations in 'R'.
'nlrx' experiments use a similar structure as 'NetLogos' Behavior Space experiments.
However, 'nlrx' offers more flexibility and additional tools for running and analyzing complex simulation designs and sensitivity analyses.
The user defines all information that is needed in an intuitive framework, using class objects.
Experiments are submitted from 'R' to 'NetLogo' via 'XML' files that are dynamically written, based on specifications defined by the user.
By nesting model calls in future environments, large simulation design with many runs can be executed in parallel.
This also enables simulating 'NetLogo' experiments on remote high performance computing machines.
In order to use this package, 'Java' and 'NetLogo' (>= 5.3.1) need to be available on the executing system.

Sebastian Hanss

nlrx

Setup, Run and Analyze 'NetLogo' Model Simulations from 'R' via
'XML'

Jan Salecker

Marco Sciaini

Marina Papadopoulou

nldoc_write_nldoc function

<dl><dt>noxygen</dt>
<dd>list with parsed and processed noxygen tags from NetLogo model code</dd>
<dt>noxygen_it</dt>
<dd>list with parsed and processed infotab strings</dd>
<dt>noxygen_gui</dt>
<dd>list with parsed and processed noxygen tags from NetLogo GUI elements</dd>
<dt>noxygen_bs</dt>
<dd>list with parsed and processed noxygen tags from NetLogo behavior space experiments</dd>
<dt>outpath</dt>
<dd>Path to folder where rendered documentation should be created</dd>
<dt>output_format</dt>
<dd>either "html", "pdf" or "docx"</dd>
<dt>number_sections</dt>
<dd>TRUE/FALSE, if TRUE sections in the documentation will be numbered</dd>
<dt>theme</dt>
<dd>markdown theme, supported themes are "journal", "cerulean", "flatly", "readable", "spacelab", "united", "cosmo"</dd>
<dt>date</dt>
<dd>date that is printed in the documentation header</dd>
<dt>toc</dt>
<dd>TRUE/FALSE, if TRUE the documentation contains a table of contents - only for html and pdf output format</dd></dl>

Arguments

Write NetLogo documentation — nldoc_write_nldoc

<dl>

<dt>noxygen</dt>
<dd>list with parsed and processed noxygen tags from NetLogo model code</dd>


<dt>noxygen_it</dt>
<dd>list with parsed and processed infotab strings</dd>


<dt>noxygen_gui</dt>
<dd>list with parsed and processed noxygen tags from NetLogo GUI elements</dd>


<dt>noxygen_bs</dt>
<dd>list with parsed and processed noxygen tags from NetLogo behavior space experiments</dd>


<dt>outpath</dt>
<dd>Path to folder where rendered documentation should be created</dd>


<dt>output_format</dt>
<dd>either "html", "pdf" or "docx"</dd>


<dt>number_sections</dt>
<dd>TRUE/FALSE, if TRUE sections in the documentation will be numbered</dd>


<dt>theme</dt>
<dd>markdown theme, supported themes are "journal", "cerulean", "flatly", "readable", "spacelab", "united", "cosmo"</dd>


<dt>date</dt>
<dd>date that is printed in the documentation header</dd>


<dt>toc</dt>
<dd>TRUE/FALSE, if TRUE the documentation contains a table of contents - only for html and pdf output format</dd>

</dl>

Write NetLogo documentation

nldoc_write_nldoc: Write NetLogo documentation

Description

Usage

Value

Arguments

Details