village_state

<p>This is an object that represents the state of a village at a particular 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

village_state function

<p></p><p></p><p><dl></dl></p><p></p><p>Creates a new State</p>

Methods

<p><div class="r6-fields"></div></p><dl>
<dt><code>step</code></dt>
<dd><p>The time step that the state is relevant to</p></dd><p></p><p>
<dt><code>agent_states</code></dt>
<dd><p>A list of agent states</p></dd></p><p>
<dt><code>resource_states</code></dt>
<dd><p>A list of resource states</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/village_state%24new()?package=villager&version=2.0.0" data-mini-rdoc="villager::village_state$new()"><code>village_state$new()</code></a></p></li>
<li><p><a href="/link/village_state%24clone()?package=villager&version=2.0.0" data-mini-rdoc="villager::village_state$clone()"><code>village_state$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-village_state-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Initializes all of the properties in the state to the ones passed in. This should
be called by subclasses during initialization.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>village_state$new(
  step = 0,
  agent_states = vector(),
  resource_states = vector()
)</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>step</code></dt>
<dd><p>The time step that the state is relevant to</p></dd></dl></div></p><p>
<dt><code>agent_states</code></dt>
<dd><p>A vector of tibbles representing the states of the agents</p></dd></p><p>
<dt><code>resource_states</code></dt>
<dd><p>A vector of tibbles representing the states of the resources</p></dd></p><p>
</p><p></p>

<div class="section" id="details">
<h4>Details</h4>
<p>When adding a new property, make sure to add it to the tibble
representation.</p>
</div><p></p><p>
</p><p><hr>
<a id="method-village_state-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>village_state$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>

village_state — village_state





<dl>

</dl><p>Creates a new State</p>

<p><div class="r6-fields"></p><dl>
<dt><code>step</code></dt>
<dd><p>The time step that the state is relevant to</p></dd>


<dt><code>agent_states</code></dt>
<dd><p>A list of agent states</p></dd>


<dt><code>resource_states</code></dt>
<dd><p>A list of resource states</p></dd>


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


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

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

</div><p><hr>
<a id="method-village_state-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Initializes all of the properties in the state to the ones passed in. This should
be called by subclasses during initialization.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>village_state$new(
  step = 0,
  agent_states = vector(),
  resource_states = vector()
)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>step</code></dt>
<dd><p>The time step that the state is relevant to</p></dd>


<dt><code>agent_states</code></dt>
<dd><p>A vector of tibbles representing the states of the agents</p></dd>


<dt><code>resource_states</code></dt>
<dd><p>A vector of tibbles representing the states of the resources</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='details'>
<h4>Details</h4>
<p>When adding a new property, make sure to add it to the tibble
representation.</p>
</div>


</div><p><hr>
<a id="method-village_state-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>village_state$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>


village_state: village_state

Description

Arguments

Methods

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Details

Method `clone()`

Usage

Arguments

Details

Description

Arguments

Methods

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Details

Method clone()

Usage

Arguments

Details

Method `new()`

Method `clone()`