Documentation for SLiM function setSexRatio
, 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.
setSexRatio(sexRatio)
An object of type float. Must be of length 1 (a singleton). See details for description.
An object of type void.
Documentation for this function can be found in the official SLiM manual: page 744.
Set the sex ratio of this subpopulation to sexRatio. As defined in SLiM, this is actually the fraction of the subpopulation that is male; in other words, the M:(M+F) ratio. This will take effect when children are next generated; it does not change the current subpopulation state. Unlike the selfing rate, the cloning rate, and migration rates, the sex ratio is deterministic: SLiM will generate offspring that exactly satisfy the requested sex ratio (within integer roundoff limits). See section 23.2.1 for further details.
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/
Other Subpopulation:
Subpopulation
,
addCloned()
,
addCrossed()
,
addEmpty()
,
addRecombinant()
,
addSelfed()
,
addSpatialMap()
,
cachedFitness()
,
configureDisplay()
,
defineSpatialMap()
,
outputMSSample()
,
outputSample()
,
outputVCFSample()
,
pointDeviated()
,
pointInBounds()
,
pointPeriodic()
,
pointReflected()
,
pointStopped()
,
pointUniform()
,
removeSpatialMap()
,
removeSubpopulation()
,
sampleIndividuals()
,
setCloningRate()
,
setMigrationRates()
,
setSelfingRate()
,
setSpatialBounds()
,
setSubpopulationSize()
,
spatialMapColor()
,
spatialMapImage()
,
spatialMapValue()
,
subsetIndividuals()
,
takeMigrants()