Documentation for SLiM function calcVA
, which is a method of the SLiM
class SLiMBuiltin
.
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.
calcVA(individuals, mutType)
An object of type Individual object. See details for description.
An object of type integer or MutationType object. Must be of length 1 (a singleton). See details for description.
An object of type float. Return will be of length 1 (a singleton)
Documentation for this function can be found in the official SLiM manual: page 753.
Calculates VA, the additive genetic variance, among a vector individuals, in a particular mutation type mutType that represents quantitative trait loci (QTLs) influencing a quantitative phenotypic trait. The mutType parameter may be either an integer representing the ID of the desired mutation type, or a MutationType object specified directly. This function assumes that mutations of type mutType encode their effect size upon the quantitative trait in their selectionCoeff property, as is fairly standard in SLiM (see, e.g., section 13.2). The implementation of calcVA(), which is viewable with functionSource(), is quite simple; if effect sizes are stored elsewhere (such as with setValue(), as in section 13.5), a new user-defined function following the pattern of calcVA() can easily be written.
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 SLiMBuiltin:
SB
,
calcFST()
,
calcHeterozygosity()
,
calcInbreedingLoad()
,
calcPairHeterozygosity()
,
calcWattersonsTheta()
,
codonsToAminoAcids()
,
mm16To256()
,
mmJukesCantor()
,
mmKimura()
,
nucleotideCounts()
,
nucleotideFrequencies()
,
nucleotidesToCodons()
,
summarizeIndividuals()
,
treeSeqMetadata()
## This just brings up the documentation:
calcVA()