Documentation for SLiM function divide, which is a method of the SLiM class SpatialMap. 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.

divide(x)

Arguments

x

An object of type integer or float or SpatialMap object. See details for description.

Value

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

Details

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

Divides the spatial map by x. One possibility is that x is a singleton integer or float value; in this case, each grid value of the target spatial map is divided by x. Another possibility is that x is an integer or float vector/matrix/array of the same dimensions as the target spatial map's grid; in this case, each grid value of the target spatial map is divided by the corresponding value of x. The third possibility is that x is itself a (singleton) spatial map; in this case, each grid value of the target spatial map is divided by the corresponding grid value of x (and thus the two spatial maps must match in their spatiality, their spatial bounds, and their grid dimensions). The target spatial map is returned, to allow easy chaining of operations.

Author

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