README
¶
Drivesim
This library and set of executables allows for generation of simulated chromosomes. The SNPs on these chromosomes have uniformly-distributed positions and binomially-distributed Illumina coverages. The particular goal of this library is to simulate the effect of a sperm distorter on allele frequencies of sperm in a carrier. The allele frequencies of a distorted chromosome should be biased, but the bias should decay with distance from the distorter.
Dependencies
The base installation requires go 1.23. Some tools, specifically those that automatically detect drift in the simulated data, require spstat package at the following URL: https://github.com/jgbaldwinbrown/spstat.
Using the library
go get github.com/jgbaldwinbrown/drivesim/pkg
Installing the CLI tools
git clone https://github.com/jgbaldwinbrown/drivesim.git
cd drivesim
go install ./cmd/drivesim
go install ./cmd/drivesim_multi
Usage
Drivesim
The Drivesim command line tool generates a simple example dataset. It can be
run by simply typing drivesim after installing.
Drivesim_multi
Drivesim_multi generates the simulated data used in Baldwin-Brown et al. 2025.
It can be run by typing drivesim_multi after installing.
Directories