simulation

<p>Advances one or more villages through time</p>

This is a package for creating and running Agent Based Models (ABM). It provides a set of base classes with core functionality to allow bootstrapped models. For more intensive modeling, the supplied classes can be extended to fit researcher needs.

Thomas Thelen

villager

A Framework for Designing and Running Agent Based Models

Gerardo Aldana

Marcus Thomson

Toni Gonzalez

simulation function

<p></p><p><dl>
<dt><code>run_model()</code></dt>
<dd><p>Runs the simulation</p></dd></dl></p><p>
</p><p>Creates a new Simulation instance</p>

Methods

<p><div class="r6-fields"></div></p><dl>
<dt><code>length</code></dt>
<dd><p>The total number of time steps that the simulation runs for</p></dd><p></p><p>
<dt><code>villages</code></dt>
<dd><p>A list of villages that the simulator will run</p></dd></p><p>
<dt><code>writer</code></dt>
<dd><p>An instance of a data_writer class for writing village data to disk</p></dd></p><p>
</p></dl><p></p>

Public fields


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/simulation%24new()?package=villager&version=2.0.0" data-mini-rdoc="villager::simulation$new()"><code>simulation$new()</code></a></p></li>
<li><p><a href="/link/simulation%24run_model()?package=villager&version=2.0.0" data-mini-rdoc="villager::simulation$run_model()"><code>simulation$run_model()</code></a></p></li>
<li><p><a href="/link/simulation%24clone()?package=villager&version=2.0.0" data-mini-rdoc="villager::simulation$clone()"><code>simulation$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-simulation-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Creates a new simulation object to control the experiment</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>simulation$new(length, villages, writer = villager::data_writer$new())</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>length</code></dt>
<dd><p>The number of steps the simulation takes</p></dd></dl></div></p><p>
<dt><code>villages</code></dt>
<dd><p>A list of villages that will be simulated</p></dd></p><p>
<dt><code>writer</code></dt>
<dd><p>The data writer to be used with the villages
Runs the simulation</p></dd></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-simulation-run_model"></a></p><div class="section" id="method-run-model-">
<h3>Method <code>run_model()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>simulation$run_model()</code></pre><p></p></div></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>None</p>
</div></p><p></p><p><hr>
<a id="method-simulation-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>simulation$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

simulation — simulation



<dl>
<dt><code>run_model()</code></dt>
<dd><p>Runs the simulation</p></dd>


</dl><p>Creates a new Simulation instance</p>

<p><div class="r6-fields"></p><dl>
<dt><code>length</code></dt>
<dd><p>The total number of time steps that the simulation runs for</p></dd>


<dt><code>villages</code></dt>
<dd><p>A list of villages that the simulator will run</p></dd>


<dt><code>writer</code></dt>
<dd><p>An instance of a data_writer class for writing village data to disk</p></dd>


</dl><p></div></p>


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-simulation-new'><code>simulation$new()</code></a></p></li>
<li><p><a href='#method-simulation-run_model'><code>simulation$run_model()</code></a></p></li>
<li><p><a href='#method-simulation-clone'><code>simulation$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-simulation-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Creates a new simulation object to control the experiment</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>simulation$new(length, villages, writer = villager::data_writer$new())</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>length</code></dt>
<dd><p>The number of steps the simulation takes</p></dd>


<dt><code>villages</code></dt>
<dd><p>A list of villages that will be simulated</p></dd>


<dt><code>writer</code></dt>
<dd><p>The data writer to be used with the villages
Runs the simulation</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-simulation-run_model"></a></p><div class='section' id='method-run-model-'>
<h3>Method <code>run_model()</code></h3>

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>simulation$run_model()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>None</p>
</div>

</div><p><hr>
<a id="method-simulation-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>simulation$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


simulation: simulation

Description

Arguments

Methods

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Method `run_model()`

Usage

Returns

Method `clone()`

Usage

Arguments

Description

Arguments

Methods

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Method run_model()

Usage

Returns

Method clone()

Usage

Arguments

Method `new()`

Method `run_model()`

Method `clone()`