pycoQC


NamepycoQC JSON
Version 2.5.2 PyPI version JSON
download
home_pagehttps://github.com/a-slide/pycoQC
SummaryPycoQC computes metrics and generates interactive QC plots for Oxford Nanopore technologies sequencing data
upload_time2020-12-16 17:01:18
maintainer
docs_urlNone
authorAdrien Leger & Tommaso Leonardi
requires_python>=3.6
licenseGPLv3
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            # pycoQC v2.5.2

![pycoQC](https://raw.githubusercontent.com/a-slide/pycoQC/master/docs/pictures/pycoQC_long.png)

[![JOSS](http://joss.theoj.org/papers/ea8e08dc950622bdd5d16a65649954aa/status.svg)](http://joss.theoj.org/papers/ea8e08dc950622bdd5d16a65649954aa)
[![DOI](https://zenodo.org/badge/94531811.svg)](https://zenodo.org/badge/latestdoi/94531811)
[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/pycoQC/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link)
[![GitHub license](https://img.shields.io/github/license/a-slide/pycoQC.svg)](https://github.com/a-slide/pycoQC/blob/master/LICENSE)
[![Language](https://img.shields.io/badge/Language-Python3.6+-yellow.svg)](https://www.python.org/)

[![PyPI version](https://badge.fury.io/py/pycoQC.svg)](https://badge.fury.io/py/pycoQC)
[![Downloads](https://pepy.tech/badge/pycoqc)](https://pepy.tech/project/pycoqc)

[![Anaconda Version](https://anaconda.org/aleg/pycoqc/badges/version.svg)](https://anaconda.org/aleg/pycoqc)
[![Anaconda Downloads](https://anaconda.org/aleg/pycoqc/badges/downloads.svg)](https://anaconda.org/aleg/pycoqc)

[![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/pycoqc/README.html)
[![Bioconda Downloads](https://anaconda.org/bioconda/pycoqc/badges/downloads.svg)](https://anaconda.org/bioconda/pycoqc)

[![Build Status](https://travis-ci.com/a-slide/pycoQC.svg?branch=master)](https://travis-ci.com/a-slide/pycoQC)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/07db58961a3c4fc1b6dc34c54079b477)](https://www.codacy.com/app/a-slide/pycoQC?utm_source=github.com&utm_medium=referral&utm_content=a-slide/pycoQC&utm_campaign=Badge_Grade)

---

**PycoQC computes metrics and generates interactive QC plots for Oxford Nanopore technologies sequencing data**

PycoQC relies on the *sequencing_summary.txt* file generated by Albacore and Guppy, but if needed it can also generate a summary file from basecalled fast5 files. The package supports 1D and 1D2 runs generated with Minion, Gridion and Promethion devices, basecalled with Albacore 1.2.1+ or Guppy 2.1.3+. PycoQC is written in pure Python3. **Python 2 is not supported**. For a quick introduction see tutorial by [Tim Kahlke](https://github.com/timkahlke) available at https://timkahlke.github.io/LongRead_tutorials/QC_P.html

Full documentation is available at https://adrienleger.com/pycoQC

## Gallery

![summary](./docs/pictures/summary.gif)

![reads_len_1D_example](./docs/pictures/reads_len_1D.gif)]

![reads_len_1D_example](./docs/pictures/reads_qual_1D.gif)]

![reads_qual_len_2D_example](./docs/pictures/reads_qual_len_2D.gif)

![channels_activity](./docs/pictures/channels_activity.gif)

![output_over_time](./docs/pictures/output_over_time.gif)

![qual_over_time](./docs/pictures/qual_over_time.gif)

![len_over_time](./docs/pictures/len_over_time.gif)

![align_len](./docs/pictures/align_len_1D.gif)

![align_score](./docs/pictures/align_score_1D.gif)

![align_score_len_2D](./docs/pictures/align_score_len_2D.gif)

![alignment_coverage](./docs/pictures/alignment_coverage.gif)

![alignment_rate](./docs/pictures/alignment_rate.gif)

![alignment_summary](./docs/pictures/alignment_summary.gif)

## Example HTML reports

* [Albacore_all_RNA](https://a-slide.github.io/pycoQC/pycoQC/results/Albacore_all_RNA.html)

* [Guppy-2.1.3_basecall-1D_RNA](https://a-slide.github.io/pycoQC/pycoQC/results/Guppy-2.1.3_basecall-1D_RNA.html)

* [Guppy-2.3_basecall-1D_alignment-DNA](https://a-slide.github.io/pycoQC/pycoQC/results/Guppy-2.3_basecall-1D_alignment-DNA.html)

* [Albacore-1.2.1_basecall-1D-DNA](https://a-slide.github.io/pycoQC/pycoQC/results/Albacore-1.2.1_basecall-1D-DNA.html)

* [Guppy-2.1.3_basecall-1D_DNA_barcode](https://a-slide.github.io/pycoQC/pycoQC/results/Guppy-2.1.3_basecall-1D_DNA_barcode.html)

* [Albacore-1.7.0_basecall-1D-DNA_API](https://a-slide.github.io/pycoQC/pycoQC/results/Albacore-1.7.0_basecall-1D-DNA_API.html)

* [Albacore-2.1.10_basecall-1D-DNA](https://a-slide.github.io/pycoQC/pycoQC/results/Albacore-2.1.10_basecall-1D-DNA.html)

* [Albacore-1.7.0_basecall-1D-DNA](https://a-slide.github.io/pycoQC/pycoQC/results/Albacore-1.7.0_basecall-1D-DNA.html)

## Example JSON reports

* [Guppy-2.3_basecall-1D_alignment-DNA](https://a-slide.github.io/pycoQC/pycoQC/results/Guppy-2.3_basecall-1D_alignment-DNA.json)

* [Guppy-2.1.3_basecall-1D_RNA](https://a-slide.github.io/pycoQC/pycoQC/results/Guppy-2.1.3_basecall-1D_RNA.json)

* [Albacore-1.7.0_basecall-1D-DNA_API](https://a-slide.github.io/pycoQC/pycoQC/results/Albacore-1.7.0_basecall-1D-DNA_API.json)


## Disclaimer

Please be aware that pycoQC is a research package that is still under development.

It was tested under Linux Ubuntu 16.04 and in an HPC environment running under Red Hat Enterprise 7.1.

Thank you

## Classifiers

* Development Status :: 3 - Alpha
* Intended Audience :: Science/Research
* Topic :: Scientific/Engineering :: Bio-Informatics
* License :: OSI Approved :: GNU General Public License v3 (GPLv3)
* Programming Language :: Python :: 3

## licence

GPLv3 (https://www.gnu.org/licenses/gpl-3.0.en.html)

Copyright © 2020 Adrien Leger & Tommaso Leonardi

## Authors

* Adrien Leger & Tommaso Leonardi / aleg@ebi.ac.uk / https://adrienleger.com
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/a-slide/pycoQC",
    "name": "pycoQC",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "",
    "author": "Adrien Leger & Tommaso Leonardi",
    "author_email": "aleg@ebi.ac.uk",
    "download_url": "https://files.pythonhosted.org/packages/be/f6/4356a90a6cf4f530391000426dbc08c6db9822cb7c89446040a9df17f904/pycoQC-2.5.2.tar.gz",
    "platform": "",
    "description": "# pycoQC v2.5.2\n\n![pycoQC](https://raw.githubusercontent.com/a-slide/pycoQC/master/docs/pictures/pycoQC_long.png)\n\n[![JOSS](http://joss.theoj.org/papers/ea8e08dc950622bdd5d16a65649954aa/status.svg)](http://joss.theoj.org/papers/ea8e08dc950622bdd5d16a65649954aa)\n[![DOI](https://zenodo.org/badge/94531811.svg)](https://zenodo.org/badge/latestdoi/94531811)\n[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/pycoQC/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link)\n[![GitHub license](https://img.shields.io/github/license/a-slide/pycoQC.svg)](https://github.com/a-slide/pycoQC/blob/master/LICENSE)\n[![Language](https://img.shields.io/badge/Language-Python3.6+-yellow.svg)](https://www.python.org/)\n\n[![PyPI version](https://badge.fury.io/py/pycoQC.svg)](https://badge.fury.io/py/pycoQC)\n[![Downloads](https://pepy.tech/badge/pycoqc)](https://pepy.tech/project/pycoqc)\n\n[![Anaconda Version](https://anaconda.org/aleg/pycoqc/badges/version.svg)](https://anaconda.org/aleg/pycoqc)\n[![Anaconda Downloads](https://anaconda.org/aleg/pycoqc/badges/downloads.svg)](https://anaconda.org/aleg/pycoqc)\n\n[![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/pycoqc/README.html)\n[![Bioconda Downloads](https://anaconda.org/bioconda/pycoqc/badges/downloads.svg)](https://anaconda.org/bioconda/pycoqc)\n\n[![Build Status](https://travis-ci.com/a-slide/pycoQC.svg?branch=master)](https://travis-ci.com/a-slide/pycoQC)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/07db58961a3c4fc1b6dc34c54079b477)](https://www.codacy.com/app/a-slide/pycoQC?utm_source=github.com&utm_medium=referral&utm_content=a-slide/pycoQC&utm_campaign=Badge_Grade)\n\n---\n\n**PycoQC computes metrics and generates interactive QC plots for Oxford Nanopore technologies sequencing data**\n\nPycoQC relies on the *sequencing_summary.txt* file generated by Albacore and Guppy, but if needed it can also generate a summary file from basecalled fast5 files. The package supports 1D and 1D2 runs generated with Minion, Gridion and Promethion devices, basecalled with Albacore 1.2.1+ or Guppy 2.1.3+. PycoQC is written in pure Python3. **Python 2 is not supported**. For a quick introduction see tutorial by [Tim Kahlke](https://github.com/timkahlke) available at https://timkahlke.github.io/LongRead_tutorials/QC_P.html\n\nFull documentation is available at https://adrienleger.com/pycoQC\n\n## Gallery\n\n![summary](./docs/pictures/summary.gif)\n\n![reads_len_1D_example](./docs/pictures/reads_len_1D.gif)]\n\n![reads_len_1D_example](./docs/pictures/reads_qual_1D.gif)]\n\n![reads_qual_len_2D_example](./docs/pictures/reads_qual_len_2D.gif)\n\n![channels_activity](./docs/pictures/channels_activity.gif)\n\n![output_over_time](./docs/pictures/output_over_time.gif)\n\n![qual_over_time](./docs/pictures/qual_over_time.gif)\n\n![len_over_time](./docs/pictures/len_over_time.gif)\n\n![align_len](./docs/pictures/align_len_1D.gif)\n\n![align_score](./docs/pictures/align_score_1D.gif)\n\n![align_score_len_2D](./docs/pictures/align_score_len_2D.gif)\n\n![alignment_coverage](./docs/pictures/alignment_coverage.gif)\n\n![alignment_rate](./docs/pictures/alignment_rate.gif)\n\n![alignment_summary](./docs/pictures/alignment_summary.gif)\n\n## Example HTML reports\n\n* [Albacore_all_RNA](https://a-slide.github.io/pycoQC/pycoQC/results/Albacore_all_RNA.html)\n\n* [Guppy-2.1.3_basecall-1D_RNA](https://a-slide.github.io/pycoQC/pycoQC/results/Guppy-2.1.3_basecall-1D_RNA.html)\n\n* [Guppy-2.3_basecall-1D_alignment-DNA](https://a-slide.github.io/pycoQC/pycoQC/results/Guppy-2.3_basecall-1D_alignment-DNA.html)\n\n* [Albacore-1.2.1_basecall-1D-DNA](https://a-slide.github.io/pycoQC/pycoQC/results/Albacore-1.2.1_basecall-1D-DNA.html)\n\n* [Guppy-2.1.3_basecall-1D_DNA_barcode](https://a-slide.github.io/pycoQC/pycoQC/results/Guppy-2.1.3_basecall-1D_DNA_barcode.html)\n\n* [Albacore-1.7.0_basecall-1D-DNA_API](https://a-slide.github.io/pycoQC/pycoQC/results/Albacore-1.7.0_basecall-1D-DNA_API.html)\n\n* [Albacore-2.1.10_basecall-1D-DNA](https://a-slide.github.io/pycoQC/pycoQC/results/Albacore-2.1.10_basecall-1D-DNA.html)\n\n* [Albacore-1.7.0_basecall-1D-DNA](https://a-slide.github.io/pycoQC/pycoQC/results/Albacore-1.7.0_basecall-1D-DNA.html)\n\n## Example JSON reports\n\n* [Guppy-2.3_basecall-1D_alignment-DNA](https://a-slide.github.io/pycoQC/pycoQC/results/Guppy-2.3_basecall-1D_alignment-DNA.json)\n\n* [Guppy-2.1.3_basecall-1D_RNA](https://a-slide.github.io/pycoQC/pycoQC/results/Guppy-2.1.3_basecall-1D_RNA.json)\n\n* [Albacore-1.7.0_basecall-1D-DNA_API](https://a-slide.github.io/pycoQC/pycoQC/results/Albacore-1.7.0_basecall-1D-DNA_API.json)\n\n\n## Disclaimer\n\nPlease be aware that pycoQC is a research package that is still under development.\n\nIt was tested under Linux Ubuntu 16.04 and in an HPC environment running under Red Hat Enterprise 7.1.\n\nThank you\n\n## Classifiers\n\n* Development Status :: 3 - Alpha\n* Intended Audience :: Science/Research\n* Topic :: Scientific/Engineering :: Bio-Informatics\n* License :: OSI Approved :: GNU General Public License v3 (GPLv3)\n* Programming Language :: Python :: 3\n\n## licence\n\nGPLv3 (https://www.gnu.org/licenses/gpl-3.0.en.html)\n\nCopyright \u00a9 2020 Adrien Leger & Tommaso Leonardi\n\n## Authors\n\n* Adrien Leger & Tommaso Leonardi / aleg@ebi.ac.uk / https://adrienleger.com",
    "bugtrack_url": null,
    "license": "GPLv3",
    "summary": "PycoQC computes metrics and generates interactive QC plots for Oxford Nanopore technologies sequencing data",
    "version": "2.5.2",
    "project_urls": {
        "Homepage": "https://github.com/a-slide/pycoQC"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bef64356a90a6cf4f530391000426dbc08c6db9822cb7c89446040a9df17f904",
                "md5": "4a2ae2dcfdbc220a22fa6d2a2618709b",
                "sha256": "8ceba86bb9a08bdf7c329a165d0218ad8b026f6772efa661fcc98750acc2c8ce"
            },
            "downloads": -1,
            "filename": "pycoQC-2.5.2.tar.gz",
            "has_sig": false,
            "md5_digest": "4a2ae2dcfdbc220a22fa6d2a2618709b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 35235,
            "upload_time": "2020-12-16T17:01:18",
            "upload_time_iso_8601": "2020-12-16T17:01:18.104906Z",
            "url": "https://files.pythonhosted.org/packages/be/f6/4356a90a6cf4f530391000426dbc08c6db9822cb7c89446040a9df17f904/pycoQC-2.5.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-12-16 17:01:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "a-slide",
    "github_project": "pycoQC",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "lcname": "pycoqc"
}
        
Elapsed time: 0.57242s