Documentation for SLiM function addEmpty, 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.
addEmpty(sex, genome1Null, genome2Null, count)An object of type null or float or string. Must be of length 1 (a
singleton). The default value is NULL. See details for description.
An object of type null or logical. Must be of length 1 (a
singleton). The default value is NULL. See details for description.
An object of type null or logical. Must be of length 1 (a
singleton). The default value is NULL. See details for description.
An object of type integer. Must be of length 1 (a singleton). The
default value is 1. See details for description.
An object of type Individual object.
Documentation for this function can be found in the official SLiM manual: page 734.
Generates a new offspring individual with empty genomes (i.e., containing no mutations), queues it for addition to the target subpopulation, and returns it. The new offspring will not be visible as a member of the target subpopulation until the end of the offspring generation tick cycle stage. No recombination() or mutation() callbacks will be called. The target subpopulation will be used to locate applicable modifyChild() callbacks governing the generation of the offspring individual (unlike the other addX() methods, because there is no parental individual to reference). The offspring is considered to have no parents for the purposes of pedigree tracking. The sex parameter is treated as in addCrossed(). By default - when genome1Null and genome2Null are both NULL - null genomes will be generated instead of empty genomes only in sex-chromosome simulations, where the sex chromosome that is not being simulated is represented by a null genome; otherwise, empty genomes rather than null genomes will be created. This default behavior can be changed by passing T or F for genome1Null or genome2Null, which will force the corresponding offspring genome to be null (T) or non-null (F). The behavior in sex-chromosome simulations cannot be changed, since the presence of null genomes there is dictated by sex, but T or F may be passed as long as it matches what SLiM would do anyway. In all other simulations there is little point in passing F (since that would be the default behavior anyway), but passing T can be used to make one or both genomes be null genomes, which can be useful for, e.g., modeling haploids (for which, by convention, the second genome is usually a null genome in SLiM). Beginning in SLiM 4.1, the count parameter dictates how many offspring will be generated (previously, exactly one offspring was generated). Each offspring is generated independently, based upon the given parameters. The returned vector contains all generated offspring, except those that were rejected by a modifyChild() callback. If all offspring are rejected, object<Individual>(0) is returned, which is a zero-length object vector of class Individual; note that this is a change in behavior from earlier versions, which would return NULL. Note that this method is only for use in nonWF models. See addCrossed() for further general notes on the addition of new offspring individuals.
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(),
addRecombinant(),
addSelfed(),
addSpatialMap(),
cachedFitness(),
configureDisplay(),
defineSpatialMap(),
outputMSSample(),
outputSample(),
outputVCFSample(),
pointDeviated(),
pointInBounds(),
pointPeriodic(),
pointReflected(),
pointStopped(),
pointUniform(),
removeSpatialMap(),
removeSubpopulation(),
sampleIndividuals(),
setCloningRate(),
setMigrationRates(),
setSelfingRate(),
setSexRatio(),
setSpatialBounds(),
setSubpopulationSize(),
spatialMapColor(),
spatialMapImage(),
spatialMapValue(),
subsetIndividuals(),
takeMigrants()