Skip to main content

Single Cell Lineage Reconstruction with Cas9-Enabled Lineage Recorders

Project description

This is a software suite for proecessing data from single cell lineage tracing experiments. This suite comes equipped with three main modules:

  • Target Site Sequencing Pipeline: a pipeline for extracing lineage information from raw fastqs produced from a lineage tracing experiment.

  • Phylogeny Reconstruction: a collection of tools for constructing phylogenies. We support 5 algorithms currently: a greedy algorithm based on multi-state compatibility, an exact Steiner-Tree solver, Cassiopeia (the combination of these two), Neighbor-Joining, and Camin-Sokal Maximum Parsimony.

  • Benchmarking: a set of tools for benchmarking; a simulation framework and tree comparsion tools.

You can find all documentation [here](https://cassiopeia-lineage.readthedocs.io/en/latest/readme.html)

You can also find example notebooks in this repository:

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](http://www.gurobi.com/academia/for-universities). 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. Make sure that Emboss is properly configurd and installed; oftentimes users may see a “command not found” error when attempting to align with the align_sequences function we have provided. This is most likely due to the fact that you have not properly added the binary file to your path variable. For details on how to download, configure, and install the Emboss package, refer to this [tutorial](http://emboss.open-bio.org/html/adm/ch01s01.html).

  5. Install the package using the following commands:
    • python3.6 setup.py build

    • python3.6 setup.py build_ext --inplace

    • python3.6 setup.py bdist_wheel

    • python3.6 -m pip install . --user

To verify that it installed correctly, try using the package in a python session: import Cassiopeia. Then, to make sure that the command-line tools work, try reconstruct-lineage -h and confirm that you get the usage details.

Command Line Tools

In addition to allowing users to use Cassiopeia from a python session, we provide five unique command line tools for common pipeline procedures:

  • reconstruct-lineage: Reconstructs a lineage from a provided character matrix (consisting of cells x characters where each element is the observed state of that character in that cell).

  • post-process-tree: Post-process trees after reconstructing to assign sample identities back to leaves of the tree and removing any leaves that don’t correspond to a sample in the character matrix.

  • stress-test: Conduct stress testing on a given simulated tree. Writes out a new tree file after inferring a tree from the unique leaves of the “true”, simulated tree.

  • simulate-tree: Simulate a tree.

  • call-lineages: Perform lineage group calling from a molecule table.

  • filter-molecule-table: Perform molecule table filtering.

All usage details can be found by using the -h flag.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cassiopeia-lineage-1.0.0.post1.tar.gz (434.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file cassiopeia-lineage-1.0.0.post1.tar.gz.

File metadata

  • Download URL: cassiopeia-lineage-1.0.0.post1.tar.gz
  • Upload date:
  • Size: 434.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.9.1 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.23.0 CPython/3.6.9

File hashes

Hashes for cassiopeia-lineage-1.0.0.post1.tar.gz
Algorithm Hash digest
SHA256 e8d24cd32b190b534167eb189b8e54808713d1066f560d9d253011c1b3f77125
MD5 c100a38029468b16273c823d4b23cf56
BLAKE2b-256 2be6caa4a5c4958f355ca559b4f3d926787c8e988c6ce769ea5bb32ba056a3a3

See more details on using hashes here.

File details

Details for the file cassiopeia_lineage-1.0.0.post1-py3.6-linux-x86_64.egg.

File metadata

  • Download URL: cassiopeia_lineage-1.0.0.post1-py3.6-linux-x86_64.egg
  • Upload date:
  • Size: 1.6 MB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.9.1 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.23.0 CPython/3.6.9

File hashes

Hashes for cassiopeia_lineage-1.0.0.post1-py3.6-linux-x86_64.egg
Algorithm Hash digest
SHA256 afcbc2f07c6b582e5133034585ad80e95e794808502ba6922dc06cd169ec3513
MD5 25a336fb757432df47017d9a227f3133
BLAKE2b-256 3ce3ba9dee08b5608c9af0e1ea4d120bb159341d8fe4f52d3a014570f5be7e31

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page