R: Build and Run Spatially Explicit Agent-Based Models

# Build and Run Spatially Explicit Agent-Based Models

## Documentation for package ‘NetLogoR’ version 1.0.6

- DESCRIPTION file
- User guides, package vignettes and other documentation
- Package NEWS
- Package README

## Help Pages

A B C D E F H I L M N O P R S T U W misc

NetLogoR-package | The 'NetLogoR' package

## -- A --

agentMatrix | Create a new 'agentMatrix' object
agentMatrix-class | The 'agentMatrix' class
agentMatrix-method | Create a new 'agentMatrix' object
all | All agents?
any | Any agents?

## -- B --

bbox | Extract or set bounding box
bbox-method | Extract or set bounding box
bbox<- | Extract or set bounding box
bbox<--method | Extract or set bounding box
bk | Move backward
bk-method | Move backward

## -- C --

canMove | Can the 'turtles' move?
canMove-method | Can the 'turtles' move?
cbind | Combine R Objects by Rows or Columns
cbind.agentMatrix | Combine R Objects by Rows or Columns
cellFromPxcorPycor | Cells numbers from 'patches' coordinates
cellFromPxcorPycor-method | Cells numbers from 'patches' coordinates
clearPatches | Clear 'world"s 'patches'
clearPatches-method | Clear 'world"s 'patches'
coordinates-method | Spatial accessors and setters for 'NetLogoR' classes
count | Count agents
createOTurtles | Create ordered 'turtles'
createOTurtles-method | Create ordered 'turtles'
createTurtles | Create 'turtles'
createTurtles-method | Create 'turtles'
createWorld | Create a 'world'
createWorld-method | Create a 'world'

## -- D --

die | Kill 'turtles'
die-method | Kill 'turtles'
diffuse | Diffuse values in a 'world'
diffuse-method | Diffuse values in a 'world'
dist | Distances between agents
downhill | Move downhill
downhill-method | Move downhill
dx | x-increment
dx-method | x-increment
dy | y-increment
dy-method | y-increment

## -- E --

extent-method | Bounding box and extent methods for NetLogoR classes

## -- F --

face | Face something
face-method | Face something
fd | Move forward
fd-method | Move forward

## -- H --

hatch | Hatch new 'turtles'
hatch-method | Hatch new 'turtles'
head | Key base R functions for 'agentMatrix' class
head.agentMatrix | Key base R functions for 'agentMatrix' class
home | Return home
home-method | Return home

## -- I --

inCone | 'Agents' in cone
inCone-method | 'Agents' in cone
initialize-method | Initialize for 'agentMatrix' Class
inRadius | 'Agents' in radius
inRadius-method | 'Agents' in radius
inspect | Inspect 'turtles'
inspect-method | Inspect 'turtles'
isNLclass | Type of object
isNLclass-method | Type of object

## -- L --

layerNames-method | Methods for 'quickPlot'
layoutCircle | Layout 'turtles' on a circle
layoutCircle-method | Layout 'turtles' on a circle
left | Rotate to the left
left-method | Rotate to the left
length-method | Key base R functions for 'agentMatrix' class

## -- M --

maxNof | 'N' 'agents' with maximum
maxNof-method | 'N' 'agents' with maximum
maxOneOf | One 'agent' with maximum
maxOneOf-method | One 'agent' with maximum
maxPxcor | Maximum 'pxcor'
maxPxcor-method | Maximum 'pxcor'
maxPycor | Maximum 'pycor'
maxPycor-method | Maximum 'pycor'
minNof | 'N' 'agents' with minimum
minNof-method | 'N' 'agents' with minimum
minOneOf | One 'agent' with minimum
minOneOf-method | One 'agent' with minimum
minPxcor | Minimum 'pxcor'
minPxcor-method | Minimum 'pxcor'
minPycor | Minimum 'pycor'
minPycor-method | Minimum 'pycor'
moveTo | Move to
moveTo-method | Move to

## -- N --

neighbors | Neighbors 'patches'
neighbors-method | Neighbors 'patches'
NetLogoR | The 'NetLogoR' package
NLall | All agents?
NLall-method | All agents?
NLany | Any agents?
NLany-method | Any agents?
NLcount | Count agents
NLcount-method | Count agents
NLdist | Distances between agents
NLdist-method | Distances between agents
NLset | Set an 'agents' variable
NLset-method | Set an 'agents' variable
NLwith | 'Agents' with
NLwith-method | 'Agents' with
NLworldIndex | 'WorldMatrix' indices from vector indices
NLworldIndex-method | 'WorldMatrix' indices from vector indices
nOf | N random 'agents'
nOf-method | N random 'agents'
noPatches | No 'patches'
noTurtles | No 'turtles'
nrow-method | Key base R functions for 'agentMatrix' class
numLayers.worldArray | Methods for 'quickPlot'
numLayers.worldMatrix | Methods for 'quickPlot'

## -- O --

of | Values of an 'agents' variable
of-method | Values of an 'agents' variable
oneOf | One random 'agent'
oneOf-method | One random 'agent'
other | Others
other-method | Others

## -- P --

patch | 'Patches' coordinates
patch-method | 'Patches' coordinates
patchAhead | 'Patches' ahead
patchAhead-method | 'Patches' ahead
patchAt | 'Patches' at
patchAt-method | 'Patches' at
patchDistDir | 'Patches' at given distances and directions
patchDistDir-method | 'Patches' at given distances and directions
patches | All the 'patches' in a 'world'
patches-method | All the 'patches' in a 'world'
patchHere | 'Patches' here
patchHere-method | 'Patches' here
patchLeft | 'Patches' on the left
patchLeft-method | 'Patches' on the left
patchRight | 'Patches' on the right
patchRight-method | 'Patches' on the right
patchSet | 'Patch' set
patchSet-method | 'Patch' set
pExist | Do the patches exist?
pExist-method | Do the patches exist?
plot.agentMatrix | Basic plot methods for 'agentMatrix', 'worldMatrix', 'worldArray'
plot.worldArray | Basic plot methods for 'agentMatrix', 'worldMatrix', 'worldArray'
plot.worldMatrix | Basic plot methods for 'agentMatrix', 'worldMatrix', 'worldArray'
points.agentMatrix | Basic plot methods for 'agentMatrix', 'worldMatrix', 'worldArray'
PxcorPycorFromCell | 'Patches' coordinates from cells numbers
PxcorPycorFromCell-method | 'Patches' coordinates from cells numbers

## -- R --

randomPxcor | Random 'pxcor'
randomPxcor-method | Random 'pxcor'
randomPycor | Random 'pycor'
randomPycor-method | Random 'pycor'
randomXcor | Random 'xcor'
randomXcor-method | Random 'xcor'
randomXYcor | Random 'turtles' coordinates
randomXYcor-method | Random 'turtles' coordinates
randomYcor | Random 'ycor'
randomYcor-method | Random 'ycor'
raster2world | Convert a Raster* object into a 'worldMatrix' or 'worldArray' object
raster2world-method | Convert a Raster* object into a 'worldMatrix' or 'worldArray' object
rbind | Combine R Objects by Rows or Columns
rbind.agentMatrix | Combine R Objects by Rows or Columns
right | Rotate to the right
right-method | Rotate to the right

## -- S --

set | Set an 'agents' variable
setXY | Set 'turtles" locations
setXY-method | Set 'turtles" locations
sf2turtles | From 'sf' to 'agentMatrix'
sf2turtles-method | From 'sf' to 'agentMatrix'
show-method | Key base R functions for 'agentMatrix' class
show-method | Key base R functions for 'worldNLR' classes
sortOn | Sort 'agents'
sortOn-method | Sort 'agents'
spatRast2world | Convert a 'SpatRaster' object into a 'worldMatrix' or 'worldArray' object
spatRast2world-method | Convert a 'SpatRaster' object into a 'worldMatrix' or 'worldArray' object
spdf2turtles | From 'SpatialPointsDataFrame' to 'agentMatrix'
spdf2turtles-method | From 'SpatialPointsDataFrame' to 'agentMatrix'
sprout | Sprout new 'turtles'
sprout-method | Sprout new 'turtles'
stackWorlds | Stack 'worlds'
stackWorlds-method | Stack 'worlds'
subHeadings | Subtract 'headings'
subHeadings-method | Subtract 'headings'

## -- T --

tail | Key base R functions for 'agentMatrix' class
tail.agentMatrix | Key base R functions for 'agentMatrix' class
tExist | Do the 'turtle' exist?
tExist-method | Do the 'turtle' exist?
towards | Directions towards
towards-method | Directions towards
turtle | Select 'turtles'
turtle-method | Select 'turtles'
turtles2sf | From 'agentMatrix' to 'sf'
turtles2sf-method | From 'agentMatrix' to 'sf'
turtles2spdf | From 'agentMatrix' to 'SpatialPointsDataFrame'
turtles2spdf-method | From 'agentMatrix' to 'SpatialPointsDataFrame'
turtlesAt | 'Turtles' at
turtlesAt-method | 'Turtles' at
turtleSet | Create a 'turtle' 'agentset'
turtleSet-method | Create a 'turtle' 'agentset'
turtlesOn | 'Turtles' on
turtlesOn-method | 'Turtles' on
turtlesOwn | New 'turtles' variable
turtlesOwn-method | New 'turtles' variable

## -- U --

updateList | Update elements of a named list with elements of a second named list
updateList-method | Update elements of a named list with elements of a second named list
uphill | Move uphill
uphill-method | Move uphill

## -- W --

with | 'Agents' with
withMax | 'Agents' with maximum
withMax-method | 'Agents' with maximum
withMin | 'Agents' with minimum
withMin-method | 'Agents' with minimum
world2raster | Convert a 'worldMatrix' or 'worldArray' object into a Raster* object
world2raster-method | Convert a 'worldMatrix' or 'worldArray' object into a Raster* object
world2spatRast | Convert a 'worldMatrix' or 'worldArray' object into a 'SpatRaster' object
world2spatRast-method | Convert a 'worldMatrix' or 'worldArray' object into a 'SpatRaster' object
worldArray | The 'worldArray' class
worldArray-class | The 'worldArray' class
worldHeight | 'World' height
worldHeight-method | 'World' height
worldMatrix | The 'worldMatrix' class
worldMatrix-class | The 'worldMatrix' class
worldNLR | The 'worldNLR' class
worldNLR-class | The 'worldNLR' class
worldWidth | 'World' width
worldWidth-method | 'World' width
wrap | Wrap coordinates or pixels in a torus-like fashion
wrap-method | Wrap coordinates or pixels in a torus-like fashion

## -- misc --

$ | Subsetting and replacing for 'worldArray' class
$-method | Extract or Replace Parts of an Object
$-method | Subsetting and replacing for 'worldArray' class
.bboxCoords | '.bboxCoords' is a drop in replacement for 'raster::.bboxCoords'.
.identifyGrobToPlot-method | Methods for 'quickPlot'
==-method | Relational Operators
[ | Extract or Replace Parts of an Object
[-method | Extract or Replace Parts of an Object
[<- | Extract or Replace Parts of an Object
[<--method | Extract or Replace Parts of an Object
[[-method | Subsetting and replacing for 'worldArray' class
[[<--method | Subsetting and replacing for 'worldArray' class