Documentation for SLiM function mmJukesCantor, 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.

mmJukesCantor(alpha)

Arguments

alpha

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

Value

An object of type float.

Details

Documentation for this function can be found in the official SLiM manual: page 749.

Returns a mutation matrix representing a Jukes-Cantor (1969) model with mutation rate alpha to each possible alternative nucleotide at a site: This 2×2 matrix is suitable for use with initializeGenomicElementType(). Note that the actual mutation rate produced by this matrix is 3*alpha.

Author

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

Examples

## This just brings up the documentation:
mmJukesCantor()