Skip to content

A Package for Cas9-Enabled Single Cell Lineage Tracing Tree Reconstruction

License

Notifications You must be signed in to change notification settings

richardyz98/Cassiopeia

 
 

Repository files navigation

cassiopeia

Stars Documentation Status Build Status Coverage

Cassiopeia: A pipeline for single-cell lineage tracing data

Cassiopeia is an end-to-end pipeline for single-cell lineage tracing experiments. The software contained here comes equipped with modules for processing sequencing reads, reconstructing & plotting trees, analyzing these trees, and benchmarking new algorithms.

You can find all of our documentation here.

We also have provided tutorials for three modules:

You can also find our originally describing Cassiopeia published in Genome Biology.

Free Software: MIT License

Installation

  1. Clone the package as so: git clone https://github.com/YosefLab/Cassiopeia.git

  2. Ensure that you have python3.6 installed. You can install this via pip.

  3. Make sure that Gurobi is installed. You can follow the instructions listed here. To verify that it's working correctly, use the following tests:

    • Run the command gurobi.sh from a terminal window
    • From the Gurobi installation directory (where there is a setup.py file), use python setup.py install --user
  4. Install Cassiopeia by first making sure you have stable version of Cython and pytest. Then, you can install Cassiopeia by running make install from the directory where you have Cassiopeia downloaded.

To verify that it installed correctly, try running our tests with make test.

Reference

If you've found Cassiopeia useful for your research, please consider citing our paper published in Genome Biology:

Matthew G Jones*, Alex Khodaverdian*, Jeffrey J Quinn*, Michelle M Chan, Jeffrey A Hussmann, Robert Wang, Chenling Xu, Jonathan S Weissman, Nir Yosef. (2020), Inference of single-cell phylogenies from lineage tracing data using Cassiopeia, Genome Biology

About

A Package for Cas9-Enabled Single Cell Lineage Tracing Tree Reconstruction

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Jupyter Notebook 91.1%
  • Python 8.7%
  • Other 0.2%