sumOfMutationsOfType: SLiM method sumOfMutationsOfType
In rdinnager/slimrlang: Write SLiM Population Genetics Simulation Scripts in R

Description Usage Arguments Details Value Copyright Author(s)

View source: R/slim_lang.R View source: R/slim_lang.R

Documentation for SLiM function sumOfMutationsOfType, which is a method of the SLiM class Genome. 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.

Documentation for SLiM function sumOfMutationsOfType, which is a method of the SLiM class Individual. 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.

1
2
3

sumOfMutationsOfType(mutType)

sumOfMutationsOfType(mutType)

mutType

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

Returns the sum of the selection coefficients of all mutations that are of the type specified by mutType, out of all of the mutations in the genome. This is often useful in models that use a particular mutation type to represent QTLs with additive effects; in that context, sumOfMutationsOfType() will provide the sum of the additive effects of the QTLs for the given mutation type. This method is provided for speed; it is much faster than the corresponding Eidos code. Note that this method also exists on Individual, for cases in which the sum across both genomes of an individual is desired.

Returns the sum of the selection coefficients of all mutations that are of the type specified by mutType, out of all of the mutations in the genomes of the individual. This is often useful in models that use a particular mutation type to represent QTLs with additive effects; in that context, sumOfMutationsOfType() will provide the sum of the additive effects of the QTLs for the given mutation type. This method is provided for speed; it is much faster than the corresponding Eidos code. Note that this method also exists on Genome, for cases in which the sum for just one genome is desired.

An object of type float. Return will be of length 1 (a singleton)

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/

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

rdinnager/slimrlang documentation built on June 20, 2020, 8:17 p.m.