Documentation for SLiM function subtract, 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.
subtract(x)An object of type integer or float or SpatialMap object. See details for description.
An object of type SpatialMap object. Return will be of length 1 (a singleton)
Documentation for this function can be found in the official SLiM manual: page 717.
Subtracts x from the spatial map. One possibility is that x is a singleton integer or float value; in this case, x is subtracted from each grid value of the target spatial map. 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 value of x is subtracted from the corresponding grid value of the target spatial map. The third possibility is that x is itself a (singleton) spatial map; in this case, each grid value of x is subtracted from the corresponding grid value of the target spatial map (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.
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/
Other SpatialMap:
SpatialMap,
add(),
blend(),
changeColors(),
changeValues(),
divide(),
exp(),
gridValues(),
interpolate(),
mapColor(),
mapImage(),
mapValue(),
multiply(),
power(),
range(),
rescale(),
sampleImprovedNearbyPoint(),
sampleNearbyPoint(),
smooth()