Skip to main content
Help us improve Python packaging – donate today!

Automatically render coverage reports from Chanjo ouput

Project Description

![Example report (eng)](artwork/screenshot.png)

# Chanjo Report [![PyPI version][fury-image]][fury-url] [![Build Status][travis-image]][travis-url] Automatically generate basic coverage reports from Chanjo SQL databases. This plugin installs as a subcommand (“report”) to the Chanjo command line interface.

## Usage Chanjo Report supports a number of output formats: tabular, PDF, and HTML. To print a PDF coverage report for a group of samples “WGS-prep” do:

`bash $ chanjo report --render pdf --group "WGS-prep" > ./coverage-report.pdf `

## Features

### Supported output formats Chanjo Reports multiple output formats:

  • tabular: easily parsable and pipeable
  • PDF: easily distributable (for humans)
  • HTML: easily deliverable on the web

### Supported languages (translations) The coverage report (HTML/PDF) can be render is the following languages:

  • English
  • Swedish

## Motivation We are using the output from Chanjo at Clincal Genomics to report success of sequencing across the exome based on coverage. Our customers, clinicians mostly, are specifically interested in knowing to what degree their genes of interest are covered by sequencing along with some intuitive overall coverage metrics. They want the output in PDF format to file it in their system.

As a side effect of finding it easiest to convert HTML to PDF, Chanjo Report has a built in Flask server that can be used to render reports dynamically and even be plugged into other Flask servers as a Blueprint.

### Installation Chanjo Report is distributed through pip. Install the latest release by running:

`bash $ pip install chanjo-report `

… or locally for development:

`bash $ git clone https://github.com/robinandeer/chanjo-report.git $ cd chanjo-report $ pip install --editable . `

> Note that I will eventually provide a fully provisioned Vagrant environment to ease development setup :smiley:

## License MIT. See the [LICENSE](LICENSE) file for more details.

## Contributing Anyone can help make this project better - read [CONTRIBUTING](CONTRIBUTING.md) to get started!

[fury-url]: http://badge.fury.io/py/chanjo-report [fury-image]: https://badge.fury.io/py/chanjo-report.png

[travis-url]: https://travis-ci.org/robinandeer/chanjo-report [travis-image]: https://img.shields.io/travis/robinandeer/chanjo-report.svg?style=flat

Release history Release notifications

This version
History Node

4.2.0

History Node

4.1.0

History Node

4.0.0

History Node

3.0.5

History Node

3.0.4

History Node

3.0.3

History Node

3.0.2

History Node

3.0.1

History Node

3.0.0

History Node

2.6.1

History Node

2.6.0

History Node

2.5.1

History Node

2.5.0

History Node

2.4.2

History Node

2.4.1

History Node

2.4.0

History Node

2.4.0b2

History Node

2.4.0b1

History Node

2.3.2

History Node

2.3.1

History Node

2.3.0

History Node

2.2.1

History Node

2.2.0

History Node

2.1.0

History Node

2.0.1

History Node

2.0.0

History Node

1.0.1

History Node

1.0.0

History Node

1.0.0-rc1

History Node

0.0.13

History Node

0.0.12

History Node

0.0.11

History Node

0.0.10

History Node

0.0.9

History Node

0.0.8

History Node

0.0.7

History Node

0.0.6

History Node

0.0.5

History Node

0.0.4

History Node

0.0.3

History Node

0.0.2

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
chanjo_report-4.2.0-py2.py3-none-any.whl (27.6 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Oct 5, 2017
chanjo-report-4.2.0.tar.gz (23.8 kB) Copy SHA256 hash SHA256 Source None Oct 5, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page