nearestNeighborsOfPoint: SLiM method nearestNeighborsOfPoint

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

Description

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

Usage

nearestNeighborsOfPoint(subpop, point, count)

Arguments

subpop	An object of type Subpopulation object. Must be of length 1 (a singleton). See details for description.
point	An object of type float. 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.

Details

Returns up to count individuals in subpop that are spatially closest to point, according to the distance metric of the InteractionType. To obtain all of the individuals within the maximum interaction distance of point, simply pass a value for count that is greater than or equal to the size of subpop. Note that if fewer than count 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.

Value

An object of type Individual object.

Copyright

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/

Author(s)

Benjamin C Haller ([e-mail]) and Philipp W Messer ([e-mail])

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