gaynorr / AlphaSimR

R package for breeding program simulations
https://gaynorr.github.io/AlphaSimR/
Other
42 stars 18 forks source link

Write vignette on recombination #94

Open gregorgorjanc opened 1 year ago

gregorgorjanc commented 1 year ago

Is your feature request related to a problem? Please describe. There is no documentation how recombinations are simulated.

Describe the solution you'd like A short vignette describing the implemented recombination model and how recombination information is stored in recHist would be very valuable for the community.

Additional context

The current AlphaSimR version uses the gamma sprinkling model to model recombination. An older version used just the gamma model and even older versions used the count-location model.   There is no really great introduction to how these models work. The count-location and gamma models are referenced in this slide deck by Karl Broman. He also provides several relevant citations in the last slides.   You can get a little more details about the gamma sprinkling model in this paper which deals with estimating crossover interference.   The default values for AlphaSimR’s gamma sprinkling model set all crossovers coming from the crossover interference pathway with the interference parameter set to 2.6. These values roughly correspond to the crossover interreference assumed by the Kosambi mapping function.

gregorgorjanc commented 1 year ago
gregorgorjanc commented 1 year ago

Mention

gregorgorjanc commented 1 month ago

@AprilYUZhang can you please help us with this vignette? I suggest you: 1) Fork this repository 2) Copy the basic vignette 3) Port the example shown in https://github.com/gaynorr/AlphaSimR/issues/34 4) Weave in other bits mentioned in this issue https://github.com/gaynorr/AlphaSimR/blob/master/vignettes/intro.Rmd