Documentation for SLiM function neighborCountOfPoint, which is a method of the SLiM class InteractionType. Note that the R function is a stub, it does not do anything in R (except bring up this documentation). It will only do anything useful when used inside a slim_block function further nested in a slim_script function call, where it will be translated into valid SLiM code as part of a full SLiM script.

neighborCountOfPoint(point, exerterSubpop)

Arguments

point

An object of type float. See details for description.

exerterSubpop

An object of type integer or Subpopulation object. Must be of length 1 (a singleton). See details for description.

Value

An object of type integer. Return will be of length 1 (a singleton)

Details

Documentation for this function can be found in the official SLiM manual: page 697.

Returns the number of individuals in exerterSubpop that are within the maximum interaction distance according to the distance metric of the InteractionType. The subpopulation may be supplied either as an integer ID, or as a Subpopulation object. The evaluate() method must have been previously called for exerterSubpop, and positions saved at evaluation time will be used. If the InteractionType is non-spatial, this method may not be called. This method is similar to nearestNeighborsOfPoint() (when passed a large count so as to guarantee that all neighbors are returned), but this method returns only a count of the individuals, not a vector containing the individuals.

Author

Benjamin C Haller (bhaller@benhaller.com) and Philipp W Messer (messer@cornell.edu)