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

rescale(min, max)

Arguments

min

An object of type numeric or numeric. Must be of length 1 (a singleton). The default value is 0.0. See details for description.

max

An object of type numeric or numeric. Must be of length 1 (a singleton). The default value is 1.0. 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 716.

Rescales the values of the spatial map to the range [min, max]. By default, the rescaling is to the range [0.0, 1.0]. It is required that min be less than max, and that both be finite. Note that the final range may not be exactly [min, max] due to numerical error. 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)