turtle: Select 'turtles'

In PredictiveEcology/NetLogoR: Build and Run Spatially Explicit Agent-Based Models

Select turtles

Description

Report the individuals among turtles based on their who numbers and breed.

Usage

turtle(turtles, who, breed)

## S4 method for signature 'agentMatrix,numeric,missing'
turtle(turtles, who)

## S4 method for signature 'agentMatrix,numeric,character'
turtle(turtles, who, breed)

Arguments

turtles	AgentMatrix object representing the moving agents.
who	Integer. Vector of the who numbers for the selected turtles.
breed	Characters. Vector of breed names for the selected turtles. If missing, there is no distinction based upon breed.

Details

If no turtle matches the given who numbers, with potentially one of the given breed, inside turtles, then an empty agentMatrix is returned.

     If there are duplicates `who` numbers among the `turtles`, the first
     matching `turtle` with the requested `who` number is returned.

Value

AgentMatrix of the selected turtles sorted in the order of the who numbers requested. If breed was provided, the turtles selected are of one of the breed.

Author(s)

Sarah Bauduin

References

Wilensky, U. 1999. NetLogo. http://ccl.northwestern.edu/netlogo/. Center for Connected Learning and Computer-Based Modeling, Northwestern University. Evanston, IL.

See Also

https://ccl.northwestern.edu/netlogo/docs/dictionary.html#turtle

Examples

w1 <- createWorld(minPxcor = 0, maxPxcor = 9, minPycor = 0, maxPycor = 9)
t1 <- createTurtles(n = 10, coords = randomXYcor(w1, n = 10))
t2 <- turtle(t1, who = 2)

PredictiveEcology/NetLogoR documentation built on Jan. 31, 2024, 9:31 p.m.