Pre-release
This release is a pre-release and may not be stable for production use.
<p align="center">
<a href="http://chanjo.co">
<img height="235"
width="244"
src="artwork/logo.png"/>
</a>
</p>
# Chanjo [![PyPI version][fury-image]][fury-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url]
# Chanjo
Chanjo is coverage analysis for clinical sequencing. It's implemented in Python with a command line interface that adheres to [UNIX pipeline philisophy][unix].
## Installation
Chanjo is distruibuted through "pip". Install the latest release by running:
```bash
$ pip install chanjo
```
... or locally for development:
```bash
$ git clone https://github.com/robinandeer/chanjo.git && cd chanjo
$ pip install --editable .
```
Do note that Chanjo is built on some of kind-of tricky dependencies. If you are experiencing any issues, help is just a click away in the [documentation][docs].
## Usage
Chanjo exposes a composable command line interface. You can always save intermediary files at any stage and customize every option. However, using a ``chanjo.toml`` config and UNIX pipes you can end up with something like:
```bash
$ chanjo convert CCDS.sorted.txt | chanjo annotate alignment.bam > coverage.bed
```
## Documentation
Read the Docs is hosting the [official documentation][docs].
I can specifically recommend the fully [interactive demo](http://www.chanjo.co/en/latest/introduction.html#demo), complete with sample data to get you started right away.
## Features
### What Chanjo does
Chanjo works on BAM alignment files and extracts interesting coverage related statistics. You use a BED-file to define which regions of the genome that you particularly care about. The output takes the shape of an extended BED-file.
An optional final step is to load data into a SQL database. This will aggregate data from exons to transcripts and genes. The database will later work as an API to downstream tools like the Chanjo Coverage Report generator.
### What Chanjo doesn't
Chanjo is not the right choice if you care about coverage for every base across the entire genome. Detailed histograms is something [BEDTools][bedtools] already handles with confidence.
## Contributors
Robin Andeer
Luca Beltrame ([lbeltrame](https://github.com/lbeltrame))
## License
MIT. See the [LICENSE](LICENSE) file for more details.
## Contributing
Anyone can help make this project better - read [CONTRIBUTION](CONTRIBUTION.md) to get started!
[unix]: http://en.wikipedia.org/wiki/Unix_philosophy
[docs]: http://www.chanjo.co/en/latest/
[bedtools]: http://bedtools.readthedocs.org/en/latest/
[coveralls-url]: https://coveralls.io/r/robinandeer/chanjo
[coveralls-image]: https://img.shields.io/coveralls/robinandeer/chanjo.svg
[fury-url]: http://badge.fury.io/py/chanjo
[fury-image]: https://badge.fury.io/py/chanjo.png
[travis-url]: https://travis-ci.org/robinandeer/chanjo
[travis-image]: https://travis-ci.org/robinandeer/chanjo.png?branch=master
<a href="http://chanjo.co">
<img height="235"
width="244"
src="artwork/logo.png"/>
</a>
</p>
# Chanjo [![PyPI version][fury-image]][fury-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url]
# Chanjo
Chanjo is coverage analysis for clinical sequencing. It's implemented in Python with a command line interface that adheres to [UNIX pipeline philisophy][unix].
## Installation
Chanjo is distruibuted through "pip". Install the latest release by running:
```bash
$ pip install chanjo
```
... or locally for development:
```bash
$ git clone https://github.com/robinandeer/chanjo.git && cd chanjo
$ pip install --editable .
```
Do note that Chanjo is built on some of kind-of tricky dependencies. If you are experiencing any issues, help is just a click away in the [documentation][docs].
## Usage
Chanjo exposes a composable command line interface. You can always save intermediary files at any stage and customize every option. However, using a ``chanjo.toml`` config and UNIX pipes you can end up with something like:
```bash
$ chanjo convert CCDS.sorted.txt | chanjo annotate alignment.bam > coverage.bed
```
## Documentation
Read the Docs is hosting the [official documentation][docs].
I can specifically recommend the fully [interactive demo](http://www.chanjo.co/en/latest/introduction.html#demo), complete with sample data to get you started right away.
## Features
### What Chanjo does
Chanjo works on BAM alignment files and extracts interesting coverage related statistics. You use a BED-file to define which regions of the genome that you particularly care about. The output takes the shape of an extended BED-file.
An optional final step is to load data into a SQL database. This will aggregate data from exons to transcripts and genes. The database will later work as an API to downstream tools like the Chanjo Coverage Report generator.
### What Chanjo doesn't
Chanjo is not the right choice if you care about coverage for every base across the entire genome. Detailed histograms is something [BEDTools][bedtools] already handles with confidence.
## Contributors
Robin Andeer
Luca Beltrame ([lbeltrame](https://github.com/lbeltrame))
## License
MIT. See the [LICENSE](LICENSE) file for more details.
## Contributing
Anyone can help make this project better - read [CONTRIBUTION](CONTRIBUTION.md) to get started!
[unix]: http://en.wikipedia.org/wiki/Unix_philosophy
[docs]: http://www.chanjo.co/en/latest/
[bedtools]: http://bedtools.readthedocs.org/en/latest/
[coveralls-url]: https://coveralls.io/r/robinandeer/chanjo
[coveralls-image]: https://img.shields.io/coveralls/robinandeer/chanjo.svg
[fury-url]: http://badge.fury.io/py/chanjo
[fury-image]: https://badge.fury.io/py/chanjo.png
[travis-url]: https://travis-ci.org/robinandeer/chanjo
[travis-image]: https://travis-ci.org/robinandeer/chanjo.png?branch=master
3 maintainers
Metadata
3 maintainers
Release files for chanjo 2.0.0-beta6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| chanjo-2.0.0-beta6.tar.gz | 63.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| chanjo-2.0.0_beta6-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 113.1 kB
Release files / chanjo-2.0.0-beta6.tar.gz
| Download URL | chanjo-2.0.0-beta6.tar.gz |
|---|---|
| Size | 63.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
454e284686371c813269e400dca9070f4970e593af253d30b282570b49fd58a3
|
|
BLAKE2b-256 checksum How to use checksums |
0abe632eacd304359cef21a1753db0b93ac3dcf21b0e9ed6fbaba44d281f485c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / chanjo-2.0.0_beta6-py2.py3-none-any.whl
| Download URL | chanjo-2.0.0_beta6-py2.py3-none-any.whl |
|---|---|
| Size | 49.2 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
25545facea183d8eb1ceddace7b6978591e9e0e254584e74ba48233987dc2bd6
|
|
BLAKE2b-256 checksum How to use checksums |
d9b2015642d1f4d054774abfd319107523ae956c83411677ad1b1925baee6959
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
