scrm is a fast and accurate coalescence simulator for the evolution of biological sequences. It is available as a command line program at scrm.github.io.

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

This packages requires an R version of 3.1.0 or higher.

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

install.packages('scrm')

The development version can be installed from GitHub using

devtools::install_github('scrm/scrm-r')

Use the function scrm::scrm() to call scrm:

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

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

Please report problems with scrm using its issue tracker. Please include the version you are using and the exact command that causes the problem including seed (if applicable) in the report. Also, feel free to suggest features you would like to see in scrm there.

The R package has a version of format x.y-z. x.y is the version of scrm included in the package, and z is the number of CRAN releases for this scrm version, starting at 1 (0 is used for development only).