Documentation for SLiM function addSubpopSplit, which is a method of the
SLiM class Species.
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.
addSubpopSplit(subpopID, size, sourceSubpop, sexRatio)An object of type integer or string. Must be of length 1 (a singleton). See details for description.
An object of type integer. Must be of length 1 (a singleton). See details for description.
An object of type integer or Subpopulation object. Must be of length 1 (a singleton). See details for description.
An object of type float. Must be of length 1 (a singleton). The
default value is 0.5. See details for description.
An object of type Subpopulation object. Return will be of length 1 (a singleton)
Documentation for this function can be found in the official SLiM manual: page 720.
Split off a new subpopulation with id subpopID and size individuals derived from subpopulation sourceSubpop. The subpopID parameter may be either an integer giving the ID of the new subpopulation, or a string giving the name of the new subpopulation (such as "p5" to specify an ID of 5). The sourceSubpop parameter may specify the source subpopulation either as a Subpopulation object or by integer identifier. Only if sex is enabled for the species, the initial sex ratio may optionally be specified as sexRatio (as the male fraction, M:M+F); if it is not specified, a default of 0.5 is used. The new subpopulation will be defined as a global variable immediately by this method (see section 25.16), and will also be returned by this method. Subpopulations added by this method will consist of individuals that are clonal copies of individuals from the source subpopulation, randomly chosen with probabilities proportional to fitness. The fitness of all of these initial individuals is considered to be 1.0, to avoid a doubled round of selection in the initial tick, given that fitness values were already used to choose the individuals to clone. Once this initial set of individuals has mated to produce offspring, the model is effectively of parental individuals in the source subpopulation mating randomly according to fitness, as usual in SLiM, with juveniles migrating to the newly added subpopulation. Effectively, then, then new subpopulation is created empty, and is filled by migrating juveniles from the source subpopulation, in accordance with SLiM's usual model of juvenile migration.
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 Species:
Sp,
addSubpop(),
countOfMutationsOfType(),
individualsWithPedigreeIDs(),
killIndividuals(),
mutationCounts(),
mutationFrequencies(),
mutationsOfType(),
outputFixedMutations(),
outputFull(),
outputMutations(),
readFromPopulationFile(),
recalculateFitness(),
registerFitnessEffectCallback(),
registerMateChoiceCallback(),
registerModifyChildCallback(),
registerMutationCallback(),
registerMutationEffectCallback(),
registerRecombinationCallback(),
registerReproductionCallback(),
registerSurvivalCallback(),
simulationFinished(),
skipTick(),
subsetMutations(),
treeSeqCoalesced(),
treeSeqOutput(),
treeSeqRememberIndividuals(),
treeSeqSimplify()