dapogon / cellcoal

CellCoal: coalescent simulation of single-cell NGS genotypes
13 stars 3 forks source link

CellCoal

CellCoal: coalescent simulation of single-cell NGS genotypes

©2020 David Posada, University of Vigo, Spain http://darwin.uvigo.es

About CellCoal

CellCoal simulates the somatic evolution of single-cells. CellCoal generates a coalescent genealogy for a sample of somatic cells –no recombination– obtained from a growing population, together with a another cell as outgroup, introduces mutations along this genealogy, and produces single-cell diploid genotypes (single-nuclotide variants or SNVs). CellCoal implements multiple mutations models (0/1, DNA, infinite and finite site models, deletion, copy-neutral LOH, 30 cancer signatures) and is able to generate read counts and genotype likelihoods considering allelic dropout, sequencing and amplification error, plus doublet cells.

Getting started

  1. Download: get the program from the GitHub repository at https://github.com/dapogon/cellcoal. Under the Code tab you will see a section call release. Click on it download the source code in .zip (or tar.gz) format. Then unzip the cellcoal-x.y.z.zip file (for example, cellcoal-1.1.0.zip). You should see now a folder called cellcoal-x.y.z. Move into the folder to compile and run the program.

  2. Compile: type make. The program should compile without much problem in Linux/MacOSX. A Makefile is provided for the gcc compiler. The executable file will be located in the bin folder.

  3. Run: bin/cellcoal-x.y.z. In this case, the program arguments will be read from a file called parameters. Alternatively, arguments can be entered directly in the command line, or from a specific parameter file with a different name.

  4. Inspect results: Once the run is finished, different output files will be written by default inside a folder called results.

Citation

Manual

A detailed manual is available in html or in pdf.