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

spatialMapImage(name, width, height, centers, color)

Arguments

name

An object of type string. Must be of length 1 (a singleton). See details for description.

width

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

height

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

centers

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

color

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

Value

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

Details

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

This method has been deprecated, and may be removed in a future release of SLiM. In SLiM 4.1 and later, use the SpatialMap method mapImage() instead, and see that method's documentation. (This method differs only in taking a name parameter, which is used to look up the spatial map from those that have been added to the subpopulation.)

Author

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