Skip to content
scrm, packaged for convenient usage in R
C++ R Shell
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R Correct several typos (#34) Dec 8, 2017
inst Prepare release (#29) Dec 11, 2016
man Correct several typos (#34) Dec 8, 2017
src Fix gcc compiler warning (#41) Nov 19, 2018
tests Fix #38 (#39) Jun 30, 2018
tools Prepare Release of Version 1.7.2-0 (#28) Dec 11, 2016
vignettes Update to scrm v1.7.3 (#40) Nov 18, 2018
.Rbuildignore Fix gcc compiler warning (#41) Nov 19, 2018
.gitattributes add windows tests on appveyor Mar 18, 2015
.gitignore
.lintr exclude RcppExports from linting Mar 30, 2015
.travis.yml Update travis config Jun 30, 2018
DESCRIPTION Fix gcc compiler warning (#41) Nov 19, 2018
NAMESPACE use shared_ptr for FastFunc Feb 22, 2016
NEWS Fix gcc compiler warning (#41) Nov 19, 2018
README.md Update README.md Nov 18, 2018
appveyor.yml add windows tests on appveyor Mar 18, 2015
scrm-r.Rproj Correct several typos (#34) Dec 8, 2017

README.md

Project Status: Active - The project has reached a stable, usable state and is being actively developed. Linux Build Status Windows Build Status CRAN Status

scrm R Package

scrm is a 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.

Installation

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

install.packages('scrm')

Usage

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

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

Help & Documentation

  • 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.

Citation

Please cite the following article when using scrm in a publication:

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

Bug Reports

Please report any problems via the issue tracker or via email to develop (at) paulstaab (dot) de.

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 there.

You can’t perform that action at this time.