Metadata-Version: 2.4
Name: whatshap
Version: 2.5
Summary: phase genomic variants using DNA sequencing reads
Author: WhatsHap authors
License: MIT
Project-URL: Homepage, https://github.com/whatshap/whatshap
Project-URL: Changelog, https://whatshap.readthedocs.io/en/latest/changes.html
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Cython
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: pysam>=0.18.0
Requires-Dist: pyfaidx>=0.5.5.2
Requires-Dist: networkx
Requires-Dist: biopython>=1.73
Requires-Dist: scipy
Requires-Dist: xopen>=1.2.0
Requires-Dist: pulp>=2
Provides-Extra: dev
Requires-Dist: Cython; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: hypothesis; extra == "dev"
Requires-Dist: sphinx>=4.4; extra == "dev"
Requires-Dist: sphinx-issues; extra == "dev"
Requires-Dist: pysam-stubs; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx<7; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: sphinx-issues; extra == "docs"
Requires-Dist: sphinx_better_subsection; extra == "docs"
Dynamic: license-file
Dynamic: requires-dist

.. image:: https://img.shields.io/pypi/v/whatshap.svg?branch=main
    :target: https://pypi.python.org/pypi/whatshap

.. image:: https://github.com/whatshap/whatshap/workflows/CI/badge.svg

.. image:: https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg
    :target: http://bioconda.github.io/recipes/whatshap/README.html

|

.. image:: https://github.com/whatshap/whatshap/raw/main/logo/whatshap_logo.png

|

WhatsHap
========

WhatsHap is a software for phasing genomic variants using DNA sequencing
reads, also called *read-based phasing* or *haplotype assembly*. It is
especially suitable for long reads, but works also well with short reads.


Features
========

  * Very accurate results (Martin et al.,
    `WhatsHap: fast and accurate read-based phasing <https://doi.org/10.1101/085050>`_)
  * Works well with Illumina, PacBio, Oxford Nanopore and other types of reads
  * It phases SNVs, indels and even “complex” variants (such as ``TCG`` → ``AGAA``)
  * Pedigree phasing mode uses reads from related individuals (such as trios)
    to improve results and to reduce coverage requirements
    (Garg et al., `Read-Based Phasing of Related Individuals <https://doi.org/10.1093/bioinformatics/btw276>`_).
  * WhatsHap is easy to install
  * It is easy to use: Pass in a VCF and one or more BAM files, get out a phased VCF.
    Supports multi-sample VCFs.
  * It produces standard-compliant VCF output by default
  * If desired, get output that is compatible with ReadBackedPhasing
  * Open Source (MIT license)


Documentation
-------------

* We recommend you start with this book chapter for a concise introduction:
  `Read-Based Phasing and Analysis of Phased Variants with WhatsHap <https://doi.org/10.1007/978-1-0716-2819-5_8>`_
* `WhatsHap documentation online <https://whatshap.readthedocs.io/>`_
* `GitHub repository <https://github.com/whatshap/whatshap/>`_


Issue tracker
-------------
Please do not hesitate to use our `issue tracker <https://github.com/whatshap/whatshap/issues>`_ for bug reports and feature requests.
