nearestInteractingNeighbors: SLiM method nearestInteractingNeighbors
In rdinnager/slimrlang: Write SLiM Population Genetics Simulation Scripts in R

Description Usage Arguments Details Value Copyright Author(s)

Documentation for SLiM function nearestInteractingNeighbors, 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.

1	nearestInteractingNeighbors(individual, count)

`individual`	An object of type Individual object. Must be of length 1 (a singleton). See details for description.
`count`	An object of type integer. Must be of length 1 (a singleton). The default value is `1`. See details for description.

Returns up to count interacting individuals that are spatially closest to individual, according to the distance metric of the InteractionType. More specifically, this method returns only individuals which can exert an interaction upon the focal individual; it does not include individuals that only feel an interaction from the focal individual. To obtain all of the interacting individuals within the maximum interaction distance of individual, simply pass a value for count that is greater than or equal to the size of individual’s subpopulation. Note that if fewer than count interacting individuals are within the maximum interaction distance, the vector returned may be shorter than count, or even zero-length; it is important to check for this possibility even when requesting a single neighbor. If only the number of interacting individuals is needed, use interactingNeighborCount() instead. Note that this method uses interaction eligibility as a criterion; it will not return neighbors that cannot exert an interaction upon the focal individual (due to sex-segregation, e.g.). (It will also never return the focal individual as a neighbor of itself.) To find all neighbors of the focal individual, whether they can interact with it or not, use nearestNeighbors().

An object of type Individual object.

This is documentation for a function in the SLiM software, and has been reproduced from the official manual, which can be found here: http://benhaller.com/slim/SLiM_Manual.pdf. This documentation is Copyright © 2016–2020 Philipp Messer. All rights reserved. More information about SLiM can be found on the official website: https://messerlab.org/slim/

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

rdinnager/slimrlang documentation built on June 20, 2020, 8:17 p.m.