vcftoolz


Namevcftoolz JSON
Version 1.2.3 PyPI version JSON
download
home_pagehttps://github.com/CFSAN-Biostatistics/vcftoolz
SummaryTools for working with Variant Call Format files.
upload_time2023-06-02 03:25:43
maintainer
docs_urlNone
authorSteve Davis
requires_python>=3.9
licenseBSD
keywords bioinformatics ngs vcftoolz
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            ===============================
VCF Toolz
===============================


.. Image showing the PyPI version badge - links to PyPI
.. image:: https://img.shields.io/pypi/v/vcftoolz.svg
        :target: https://pypi.python.org/pypi/vcftoolz

.. Image showing the Travis Continuous Integration test status, commented out for now
.. .. image:: https://img.shields.io/travis/CFSAN-Biostatistics/vcftoolz.svg
..        :target: https://travis-ci.org/CFSAN-Biostatistics/vcftoolz

.. Image showing the JOSS paper badge
.. image:: http://joss.theoj.org/papers/10.21105/joss.01144/status.svg
   :target: https://doi.org/10.21105/joss.01144

Tools for working with Variant Call Format files.

VCF Toolz was developed by the United States Food
and Drug Administration, Center for Food Safety and Applied Nutrition.

* Free software
* Documentation: https://vcftoolz.readthedocs.io
* Source Code: https://github.com/CFSAN-Biostatistics/vcftoolz
* PyPI Distribution: https://pypi.python.org/pypi/vcftoolz


Features
--------

* Compares the snps in two or more VCF files.
* Lists the snps that are unique to each VCF file with full genotype information per snp.
* Lists the snps that are missing from each VCF file if present in at least two other VCF files.
* Generates Venn diagrams of positions and snps in the VCF files.
* Reports precision, recall, and F1 score when the truth is known.
* Reports the effectiveness of filtered variants when the truth is known.
* Reformat the VCF file in a tall-narrow format for easy viewing and diffs.
* Count samples, positions, calls, snps, indels, other variants, missing calls, and filter reasons.
* Plot calls along the length of the genome and show the location of filtered calls.


Citing VCF Toolz
--------------------------------------

To cite VCF Toolz, please reference the VCF Toolz paper:

    https://doi.org/10.21105/joss.01144


License
-------

See the LICENSE file included in the VCF Toolz distribution.





History
=======

1.2.3 (2023-06-02)
------------------
* Fixed imports in our fork of pyvenn

1.2.2 (2023-06-01)
------------------
* Fixed broken Pyvenn dependency

1.2.1 (2023-05-09)
------------------
* Update PyVCF to PyVCF3

1.2.0 (2019-04-04)
---------------------
* Fix defect in narrow command wrongly printing ALT=. when GT=.
* Add the ``count`` command to count samples, positions, calls, snps, indels,
  other variants, filtered calls, missing calls, and filter reasons.
* Add the ``plot`` command to plot calls along the length of the genome and show
  the location of filtered calls.
* Change the text of the compare report to refer to "Calls", not "Sample snps".
* Drop support for Python 3.4, which is not supported by matplotlib.
* Add support for Python 3.7.

1.1.1 (2019-03-26)
---------------------
* Replace None with '.' when printing call data.
* Support VCF files with multiple alternate alleles per position.

1.1.0 (2019-02-06)
---------------------
* Support reading gzip compressed vcf files.


1.0.0 (2018-11-20)
---------------------

* First public release.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/CFSAN-Biostatistics/vcftoolz",
    "name": "vcftoolz",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "bioinformatics,NGS,vcftoolz",
    "author": "Steve Davis",
    "author_email": "steven.davis@fda.hhs.gov",
    "download_url": "https://files.pythonhosted.org/packages/e9/ba/cea71114855dc18312669f5f6b1dea2282e18db75c32598af8d8cf1c05c1/vcftoolz-1.2.3.tar.gz",
    "platform": null,
    "description": "===============================\nVCF Toolz\n===============================\n\n\n.. Image showing the PyPI version badge - links to PyPI\n.. image:: https://img.shields.io/pypi/v/vcftoolz.svg\n        :target: https://pypi.python.org/pypi/vcftoolz\n\n.. Image showing the Travis Continuous Integration test status, commented out for now\n.. .. image:: https://img.shields.io/travis/CFSAN-Biostatistics/vcftoolz.svg\n..        :target: https://travis-ci.org/CFSAN-Biostatistics/vcftoolz\n\n.. Image showing the JOSS paper badge\n.. image:: http://joss.theoj.org/papers/10.21105/joss.01144/status.svg\n   :target: https://doi.org/10.21105/joss.01144\n\nTools for working with Variant Call Format files.\n\nVCF Toolz was developed by the United States Food\nand Drug Administration, Center for Food Safety and Applied Nutrition.\n\n* Free software\n* Documentation: https://vcftoolz.readthedocs.io\n* Source Code: https://github.com/CFSAN-Biostatistics/vcftoolz\n* PyPI Distribution: https://pypi.python.org/pypi/vcftoolz\n\n\nFeatures\n--------\n\n* Compares the snps in two or more VCF files.\n* Lists the snps that are unique to each VCF file with full genotype information per snp.\n* Lists the snps that are missing from each VCF file if present in at least two other VCF files.\n* Generates Venn diagrams of positions and snps in the VCF files.\n* Reports precision, recall, and F1 score when the truth is known.\n* Reports the effectiveness of filtered variants when the truth is known.\n* Reformat the VCF file in a tall-narrow format for easy viewing and diffs.\n* Count samples, positions, calls, snps, indels, other variants, missing calls, and filter reasons.\n* Plot calls along the length of the genome and show the location of filtered calls.\n\n\nCiting VCF Toolz\n--------------------------------------\n\nTo cite VCF Toolz, please reference the VCF Toolz paper:\n\n    https://doi.org/10.21105/joss.01144\n\n\nLicense\n-------\n\nSee the LICENSE file included in the VCF Toolz distribution.\n\n\n\n\n\nHistory\n=======\n\n1.2.3 (2023-06-02)\n------------------\n* Fixed imports in our fork of pyvenn\n\n1.2.2 (2023-06-01)\n------------------\n* Fixed broken Pyvenn dependency\n\n1.2.1 (2023-05-09)\n------------------\n* Update PyVCF to PyVCF3\n\n1.2.0 (2019-04-04)\n---------------------\n* Fix defect in narrow command wrongly printing ALT=. when GT=.\n* Add the ``count`` command to count samples, positions, calls, snps, indels,\n  other variants, filtered calls, missing calls, and filter reasons.\n* Add the ``plot`` command to plot calls along the length of the genome and show\n  the location of filtered calls.\n* Change the text of the compare report to refer to \"Calls\", not \"Sample snps\".\n* Drop support for Python 3.4, which is not supported by matplotlib.\n* Add support for Python 3.7.\n\n1.1.1 (2019-03-26)\n---------------------\n* Replace None with '.' when printing call data.\n* Support VCF files with multiple alternate alleles per position.\n\n1.1.0 (2019-02-06)\n---------------------\n* Support reading gzip compressed vcf files.\n\n\n1.0.0 (2018-11-20)\n---------------------\n\n* First public release.\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "Tools for working with Variant Call Format files.",
    "version": "1.2.3",
    "project_urls": {
        "Homepage": "https://github.com/CFSAN-Biostatistics/vcftoolz"
    },
    "split_keywords": [
        "bioinformatics",
        "ngs",
        "vcftoolz"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c4b0e811a74258cb9479a70cd2db51afd701e9e54c73dd04e5043de9ec103ac9",
                "md5": "3042283ad0e4a8dce2054d30546eefca",
                "sha256": "2887a0432912deed55efadb5c7fc489a9bcfc8bf514568c0b26307594e201a4f"
            },
            "downloads": -1,
            "filename": "vcftoolz-1.2.3-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3042283ad0e4a8dce2054d30546eefca",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.9",
            "size": 25506,
            "upload_time": "2023-06-02T03:25:40",
            "upload_time_iso_8601": "2023-06-02T03:25:40.619477Z",
            "url": "https://files.pythonhosted.org/packages/c4/b0/e811a74258cb9479a70cd2db51afd701e9e54c73dd04e5043de9ec103ac9/vcftoolz-1.2.3-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e9bacea71114855dc18312669f5f6b1dea2282e18db75c32598af8d8cf1c05c1",
                "md5": "70e0036722d58a342a7ae6dca64e3144",
                "sha256": "cb6ebbc2241c15825fbc7db755878d3ccfaffa54b84b6a9b989dbed6a9d89391"
            },
            "downloads": -1,
            "filename": "vcftoolz-1.2.3.tar.gz",
            "has_sig": false,
            "md5_digest": "70e0036722d58a342a7ae6dca64e3144",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 37407,
            "upload_time": "2023-06-02T03:25:43",
            "upload_time_iso_8601": "2023-06-02T03:25:43.059591Z",
            "url": "https://files.pythonhosted.org/packages/e9/ba/cea71114855dc18312669f5f6b1dea2282e18db75c32598af8d8cf1c05c1/vcftoolz-1.2.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-02 03:25:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "CFSAN-Biostatistics",
    "github_project": "vcftoolz",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "tox": true,
    "lcname": "vcftoolz"
}
        
Elapsed time: 0.08131s