Overview of Cortexpy
| tests |   |
|---|---|
| package | 
|
| docs |
Cortexpy is a Python package for sequence analysis using linked and colored De Bruijn graphs such as the ones created by Cortex and Mccortex. This project aims to mirror many of the features contained in CortexJDK.
Cortexpy also comes with a command-line tool for basic inspection and manipulation of Cortex graphs with and without links.
The audience of cortexpy is researchers working with colored De Bruijn graphs and link information in Cortex and Mccortex format.
Cortexpy is free software; you can redistribute it and/or modify it under the terms of the Apache License version 2.0. Contributions are welcome. Please join us on GitHub.
pip install cortexpy
For more information, please see cortexpy documentation.
If you use cortexpy in your work, please consider citing:
Akhter, Shirin, Warren W. Kretzschmar, Veronika Nordal, Nicolas Delhomme, Nathaniel R. Street, Ove Nilsson, Olof Emanuelsson, and Jens F. Sundström. "Integrative analysis of three RNA sequencing methods identifies mutually exclusive exons of MADS-box isoforms during early bud development in Picea abies." Frontiers in Plant Science 9 (2018). https://doi.org/10.3389/fpls.2018.01625
This code is maintained by Warren Kretzschmar <[email protected]>. For bugs, please raise a GitHub issue.
Install conda.
Download mccortex for testing:
conda env create -f environment.yml -n my-dev-environment
Activate development environment:
conda activate my-dev-environment
Install remaining development tools:
pip3 install -r requirements.txt
All remaining commands in the development section need to be run in an activated conda dev environment.
make test
Requires access credentials for pypi.
make deploy
The documentation is automatically built by read-the-docs on push to master. To build the documentation manually:
# install sphinx dependencies pip install -r docs/requirements.txt make docs