home

home,worldNLR,agentMatrix,character-method

Move the <code>turtles</code> back <code>home</code>.

Build and run spatially explicit
agent-based models using only the R platform. 'NetLogoR' follows the same
framework as the 'NetLogo' software
(Wilensky (1999) <http://ccl.northwestern.edu/netlogo/>) and is a translation
in R of the structure and functions of 'NetLogo'.
'NetLogoR' provides new R classes to define model agents and functions to
implement spatially explicit agent-based models in the R environment.
This package allows benefiting of the fast and easy coding phase from the
highly developed 'NetLogo' framework, coupled with the versatility, power
and massive resources of the R software.
Examples of two models from the NetLogo software repository
(Ants <http://ccl.northwestern.edu/netlogo/models/Ants>) and
Wolf-Sheep-Predation
(<http://ccl.northwestern.edu/netlogo/models/WolfSheepPredation>),
and a third, Butterfly, from
Railsback and Grimm (2012) <https://www.railsback-grimm-abm-book.com/>, all
written using 'NetLogoR' are available.
The 'NetLogo' code of the original version of these
models is provided alongside.
A programming guide inspired from the 'NetLogo' Programming Guide
(<https://ccl.northwestern.edu/netlogo/docs/programming.html>) and a dictionary
of 'NetLogo' primitives (<https://ccl.northwestern.edu/netlogo/docs/dictionary.html>)
equivalences are also available.
NOTE: To increment 'time', these functions can use a for loop or can be
integrated with a discrete event simulator, such as 'SpaDES'
(<https://cran.r-project.org/package=SpaDES>).
The suggested package 'fastshp' can be installed with
'install.packages("fastshp", repos = ("<https://rforge.net>"), type = "source")'.

Eliot J B

NetLogoR

Build and Run Spatially Explicit Agent-Based Models

Sarah Bauduin

Eliot J B McIntire

Alex M Chubaty

His Majesty the King in Right of Canada, as represented by the Minister of Natural Resources Canada 

home function

<dl><dt>world</dt>
<dd><code>WorldMatrix</code> or <code>worldArray</code> object.</dd>
<dt>turtles</dt>
<dd><code>AgentMatrix</code> object representing the moving <code>agents</code>.</dd>
<dt>home</dt>
<dd>Character. Can take one of the following options to define where
to relocate the <code>turtles</code>:
<div class="sourceCode"></div><pre><code> `home = "home0"` will place the `turtles` at the location
 `x = 0, y = 0`.</code></pre></dd> `home = "center"` will place the `turtles` at the center of
 the `world`. `home = "pCorner"` will place the `turtles` at the center of
 the `patch` located in the left bottom corner of the `world`. `home = "corner"` will place the `turtles` at the left bottom
 corner of the `world`.
</dl>

Arguments

Author

Return home — home

<dl>

<dt>world</dt>
<dd><code>WorldMatrix</code> or <code>worldArray</code> object.</dd>


<dt>turtles</dt>
<dd><code>AgentMatrix</code> object representing the moving <code>agents</code>.</dd>


<dt>home</dt>
<dd>Character. Can take one of the following options to define where
to relocate the <code>turtles</code>:
<div class="sourceCode"><pre><code> `home = "home0"` will place the `turtles` at the location
 `x = 0, y = 0`.

 `home = "center"` will place the `turtles` at the center of
 the `world`.

 `home = "pCorner"` will place the `turtles` at the center of
 the `patch` located in the left bottom corner of the `world`.

 `home = "corner"` will place the `turtles` at the left bottom
 corner of the `world`.
</code></pre></div></dd>

</dl>

home: Return home

Description

Usage

Value

Arguments

Author

References

See Also

Examples