Report the coordinates of the neighbors patches around the agents.
neighbors(world, agents, nNeighbors, torus = FALSE) # S4 method for worldNLR,matrix,numeric neighbors(world, agents, nNeighbors, torus = FALSE)
| world | WorldMatrix or worldArray object. |
|---|---|
| agents | Matrix (ncol = 2) with the first column "pxcor" and the second column "pycor" representing the patches coordinates, or AgentMatrix object representing the moving agents. |
| nNeighbors | Integer: 4 or 8. Represents the number of neighbor patches considered. |
| torus | Logical to determine if the |
Matrix (ncol = 3) with the first column "pxcor"
and the second column "pycor" representing the coordinates of the neighbors
patches around the agents and the third column "id" representing
the "id" of the agents in the order provided.
The patch around which the neighbors are identified, or the patch where the turtle is located on around which the neighbors are identified, is not returned.
If torus = FALSE, agents located on the edges of the world
have less than nNeighbors patches around them. If
torus = TRUE, all agents
located on the egdes of the world have nNeighbors
patches around them, which
some may be on the other sides of the world.
Wilensky, U. 1999. NetLogo. http://ccl.northwestern.edu/netlogo/. Center for Connected Learning and Computer-Based Modeling, Northwestern University. Evanston, IL.
https://ccl.northwestern.edu/netlogo/docs/dictionary.html#neighbors
w1 <- createWorld(minPxcor = 0, maxPxcor = 9, minPycor = 0, maxPycor = 9) neighbors(world = w1, agents = patch(w1, c(0,9), c(0,7)), nNeighbors = 8)#> pxcor pycor id #> [1,] 0 1 1 #> [2,] 1 1 1 #> [3,] 1 0 1 #> [4,] 8 8 2 #> [5,] 9 8 2 #> [6,] 8 7 2 #> [7,] 8 6 2 #> [8,] 9 6 2t1 <- createTurtles(n = 3, coords = randomXYcor(w1, n = 3)) neighbors(world = w1, agents = t1, nNeighbors = 4)#> pxcor pycor id #> [1,] 6 4 1 #> [2,] 5 3 1 #> [3,] 7 3 1 #> [4,] 6 2 1 #> [5,] 4 9 2 #> [6,] 3 8 2 #> [7,] 5 8 2 #> [8,] 4 7 2 #> [9,] 6 1 3 #> [10,] 5 0 3 #> [11,] 7 0 3