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

setSuppliedValue(columnName, value)

Arguments

columnName

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

value

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

Value

An object of type void or void or void or void or void or void or void or void or void or void or void or void or void or void or void or void or void or void or logical.

Details

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

Registers a value, passed in value, to be used for the supplied column named columnName when a row is next logged. This column must have been added with addSuppliedColumn(). A value of NULL may be passed to log NA, but logging NA is the default behavior for supplied columns in any case. Otherwise, the value must be a singleton, and its type should match the values previously supplied for the column (otherwise the log file may be difficult to parse, since the values within the column will not be of one consistent type). See addSuppliedColumn() for further details.

Author

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