setGeneConversion: SLiM method setGeneConversion

Description Usage Arguments Details Value Copyright Author(s)

View source: R/slim_lang.R

Description

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

Usage

1
2
3
4
5
6
setGeneConversion(
  nonCrossoverFraction,
  meanLength,
  simpleConversionFraction,
  bias
)

Arguments

nonCrossoverFraction

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

meanLength

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

simpleConversionFraction

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

bias

An object of type numeric or numeric or numeric or numeric. Must be of length 1 (a singleton). The default value is 0. See details for description.

Details

This method switches the recombination model to the "double-stranded break (DSB)” model (if it is not already set to that), and configures the details of the gene conversion tracts that will therefore be modeled (see section 1.5.6 for discussion of the "DSB” recombination model). The meanings and effects of the parameters exactly mirror the initializeGeneConversion() function; see section 23.1 for details.

Value

An object of type void.

Copyright

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/

Author(s)

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.