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

addPopulationSize(species)

Arguments

species

An object of type null or Species object. Must be of length 1 (a singleton). The default value is NULL. 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 702.

Adds a new data column that provides the total population size for species. In single-species models, species may be NULL to indicate that single species. The column will simply be named num_individuals in single-species models; an underscore and the name of the species will be appended in multispecies models.

Author

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