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

setSelfingRate(rate)

Arguments

rate

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

Value

An object of type void.

Details

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

Set the selfing rate of this subpopulation. The rate is changed to rate, which should be between 0.0 and 1.0, inclusive. Selfing can only be enabled in non-sexual (i.e. hermaphroditic) simulations. During mating and offspring generation, the probability that any given offspring individual will be generated by selfing - by self-fertilization via gametes produced by meiosis by a single parent - will be equal to the selfing rate set in the parental (not the offspring!) subpopulation (see section 23.2.1).

Author

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