Repository files navigation

scrm is a coalescence simulator for the evolutionof biological sequences. It is available as a command line program atscrm.github.io.

This R package contains a copyscrm, packaged for convenient usage in R.

It is recommended to use the current CRAN version. It can be installedfrom within R using

install.packages('scrm')

Use the functionscrm::scrm() to callscrm:

library('scrm')sum_stats <- scrm('5 1 -r 10 100 -t 5 -oSFS')

• The basic usage ofscrm::scrm() is explained in its R help pagehelp('scrm').
• The package contains a vignette onscrm's command line arguments:vignette('scrm-Arguments').
• Online documentation for the command line program is available inscrm's Wiki.

Please cite the following article when usingscrm in a publication:

Paul R. Staab, Sha Zhu, Dirk Metzler and Gerton Lunter.scrm: efficiently simulating long sequences using the approximated coalescentwith recombination.Bioinformatics (2015) 31 (10): 1680-1682.doi:10.1093/bioinformatics/btu861.

Please report any problems via theissue trackeror via email todevelop (at) paulstaab (dot) de.

Please include the version you are using and the exact command thatcauses the problem including seed (if applicable) in the report.Also, feel free to suggest features there.