setSubpopulationSize: SLiM method setSubpopulationSize

In rdinnager/slimrlang: Write SLiM Population Genetics Simulation Scripts in R

Description

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

Usage

setSubpopulationSize(size)

Arguments

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

Details

Set the size of this subpopulation to size individuals. This will take effect when children are next generated; it does not change the current subpopulation state. Setting a subpopulation to a size of 0 does have some immediate effects that serve to disconnect it from the simulation: the subpopulation is removed from the list of active subpopulations, the subpopulation is removed as a source of migration for all other subpopulations, and the symbol representing the subpopulation is undefined. In this case, the subpopulation itself remains unchanged until children are next generated (at which point it is deallocated), but it is no longer part of the simulation and should not be used.

Value

An object of type void.

Copyright

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/

Author(s)

Benjamin C Haller ([e-mail]) and Philipp W Messer ([e-mail])

rdinnager/slimrlang documentation built on June 20, 2020, 8:17 p.m.