home: Return home
In NetLogoR: Build and Run Spatially Explicit Agent-Based Models

home	R Documentation

Return home

Description

Move the turtles back home.

Usage

home(world, turtles, home)

## S4 method for signature 'worldNLR,agentMatrix,character'
home(world, turtles, home)

Arguments

world

WorldMatrix or worldArray object.

turtles

AgentMatrix object representing the moving agents.

home

Character. Can take one of the following options to define where to relocate the turtles:

           `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`.

Value

AgentMatrix representing the turtles with updated coordinates and updated data for their previous coordinates prevX and prevY.

Author(s)

Sarah Bauduin

References

Wilensky, U. 1999. NetLogo. https://www.netlogo.org. Center for Connected Learning and Computer-Based Modeling, Northwestern University. Evanston, IL.

Examples

w1 <- createWorld(
  minPxcor = 0, maxPxcor = 4, minPycor = 0, maxPycor = 4,
  data = runif(25)
)
t1 <- createTurtles(n = 10, coords = randomXYcor(w1, n = 10))
plot(w1)
points(t1, col = "black", pch = 16)

t1 <- home(world = w1, turtles = t1, home = "pCorner")
points(t1, col = "red", pch = 16)

NetLogoR documentation built on Sept. 9, 2025, 5:27 p.m.