{ "info": { "author": "Sander Bollen", "author_email": "a.h.b.bollen@lumc.nl", "bugtrack_url": null, "classifiers": [ "Topic :: Scientific/Engineering :: Bio-Informatics" ], "description": "|Build Status| |Coverage Status|\n\nafplot\n======\n\nThis is a tool to plot allele frequencies in VCF files.\n\nThe two main subcommands that are available are: \\* ``regions``: Plot\nsingle regions or regions from a bed file, optionally with a margin. \\*\n``whole-genome``: Create a single image for every chromosome on the\ngenome.\n\nBoth subcommands have three modes:\n\n- ``histogram``: This will create a histogram with kernel density plot\n of allele frequencies.\n- ``scatter``: Create a scatter plot of allele frequencies, along the\n region or chromosome.\n- ``distance``: Create a scatter plot of distances to theoretical\n allele frequencies, along the region or chromosome. This only makes\n sense for autosomes of diploid organisms.\n\nBy default, colors correspond to call type (hom\\_alt/ref/hom\\_ref).\n\nMultiple VCF files can be supplied simultaneously for the\n``whole-genome`` subcommand, in which case they can be grouped by label.\nWhen multiple VCF files are supplied, plots will be colored on label per\nVCF file.\n\nOnly one sample per VCF file can be plotted.\n\nWe currently assume the presence of an ``AD`` column in the ``FORMAT``\nfield. This column should contain the depth per allele, with the\nreference allele being first.\n\nAll VCFs should be indexed with tabix, and should contain contigs in the\nheader.\n\nInstallation\n------------\n\nafplot is available through pypi with: ``pip install afplot``\n\nRequirements\n------------\n\n- Python 3.4+\n- click\n- numpy\n- matplotlib\n- pandas\n- seaborn\n- progressbar2\n- pysam\n- pyvcf\n\nUsage\n-----\n\n.. code:: text\n\n Usage: afplot [OPTIONS] COMMAND [ARGS]...\n\n Plot allele frequencies in VCF files.\n\n Two basic modes exist:\n - regions: Plot histogram, scatter or distance plots per\n user-specified region.\n - whole-genome: Plot histogram, scatter or distance plots over the\n entire genome.\n\n Options:\n --help Show this message and exit.\n\n Commands:\n regions Region plots\n whole-genome Whole-genome plots\n\nExamples\n--------\n\nSingle VCF on a single region\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n- ``afplot regions histogram -v my.vcf.gz -o output_dir -R chr1:100-200``\n\nSingle VCF on a bed file\n~~~~~~~~~~~~~~~~~~~~~~~~\n\n- ``afplot regions histogram -v my.vcf.gz -o output_dir -L regions.bed``\n\nSingle VCF whole genome\n~~~~~~~~~~~~~~~~~~~~~~~\n\n- ``afplot whole-genome histogram -v my.vcf.gz -l my_label -s my_sample -o mysample.histogram.png``\n\nMultiple VCFs whole genome\n~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n- ``afplot whole-genome histogram -v my1.vcf.gz -l my_label1 -s my_sample1 -v my2.vcf.gz -l my_label2 -s my_sample2 -o both_samples.histogram.png``\n\nGrouping samples can be achieved by supplying identical labels to\nsamples. E.g.\n\n- ``afplot whole-genome histogram -v 1.vcf.gz -v 2.vcf.gz -v 3.vcf.gz -v 4.vcf.gz -l group1 -l group1 -l group2 -l group2 [...]``\n\nExcluding contigs on whole genome\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIn certain cases, you may not want to plot all contigs. For instance,\nwhen your vcf header contains many small unplaced contigs. This can be\nachieved by supplying a regex pattern to the ``-e`` flag. For instance,\nall contigs containing \"gl\" can be filtered out by doing:\n\n- ``afplot whole-genome [...] -e '.*gl.*'``\n\nChangelog\n---------\n\n0.2\n~~~\n\nThe entire command line interface was changed to use ``click``, instead\nof regular argparse. This allows a more complex CLI. In stead of having\nflags for plot mode, ``afplot`` now uses subcommands.\n\nWhile the CLI has changed, and the internals of ``afplot`` have been\nrefactored, the old-style (version 0.1) API remains in place for now.\nThis may be deprecated in the future.\n\nSupport for plotting regions was added. Region plotting outputs on a\ndirectory, rather than on a single file.\n\nLicense\n-------\n\nMIT\n\n.. |Build Status| image:: https://travis-ci.org/sndrtj/afplot.svg?branch=master\n :target: https://travis-ci.org/sndrtj/afplot\n.. |Coverage Status| image:: https://coveralls.io/repos/github/sndrtj/afplot/badge.svg?branch=master\n :target: https://coveralls.io/github/sndrtj/afplot?branch=master\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/sndrtj/afplot", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "afplot", "package_url": "https://pypi.org/project/afplot/", "platform": "", "project_url": "https://pypi.org/project/afplot/", "project_urls": { "Homepage": "https://github.com/sndrtj/afplot" }, "release_url": "https://pypi.org/project/afplot/0.2.1/", "requires_dist": [ "click", "matplotlib", "numpy", "pandas", "progressbar2", "pysam", "pyvcf", "seaborn" ], "requires_python": "", "summary": "Plot allele frequencies in VCF files", "version": "0.2.1" }, "last_serial": 3014417, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "0cb3f633ee88f4c1e8997dc35d97e866", "sha256": "8726050d52e8022ab563496016c56a3764b049e7d18a85fd1fa708d89e035dee" }, "downloads": -1, "filename": "afplot-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "0cb3f633ee88f4c1e8997dc35d97e866", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8783, "upload_time": "2016-08-25T11:52:12", "url": "https://files.pythonhosted.org/packages/ab/bb/50b9097eadfc8656184e8bd8b76b1ee90d5725a56b9f6d8820072595d6f2/afplot-0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "abba7d93680b6bd18c0765ca203850b1", "sha256": "92f9c332eb3bf0b51132ad6edb92048f589fe010228cea4dc79e62285c803b9a" }, "downloads": -1, "filename": "afplot-0.1.tar.gz", "has_sig": false, "md5_digest": "abba7d93680b6bd18c0765ca203850b1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6525, "upload_time": "2016-08-25T11:52:14", "url": "https://files.pythonhosted.org/packages/32/ba/47e37575bb78bb121959c13c87153de385e809b82efe596f7591d462d9dd/afplot-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "79e943b64cf1393c6e31820a93ee1552", "sha256": "dffc9dfaf9cba1c232dce5e7778bbbe8efe39cd9171e580121dc86165183c170" }, "downloads": -1, "filename": "afplot-0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "79e943b64cf1393c6e31820a93ee1552", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 14825, "upload_time": "2017-06-06T14:29:17", "url": "https://files.pythonhosted.org/packages/41/19/5e4bf7e2d0bce223446b509cebcb810783a99e28804b366e7c3dbb9f5195/afplot-0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5c1b99f26c201c994e63b4951cd14329", "sha256": "2573fb649e05e431871e1bf8dc7c7dd03930c5d51933a2ba1e24bd03bab51fb8" }, "downloads": -1, "filename": "afplot-0.2.tar.gz", "has_sig": false, "md5_digest": "5c1b99f26c201c994e63b4951cd14329", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10410, "upload_time": "2017-06-06T14:29:19", "url": "https://files.pythonhosted.org/packages/31/98/81b775972725cc8001854ed03cd8a061aecb54e2e7e455fd7880ed7da222/afplot-0.2.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "3b097bb241cd99d48917bd92af54ab51", "sha256": "54c1d8de87eb9eb84130aa4d9741f5b1cf3fc3966de554726da63c9499a5f146" }, "downloads": -1, "filename": "afplot-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "3b097bb241cd99d48917bd92af54ab51", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 15275, "upload_time": "2017-07-11T11:57:16", "url": "https://files.pythonhosted.org/packages/d3/f6/c0615986be54594dace49a0e621528a552b54c26b8b5c1de1da057890edb/afplot-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f43752e34e4a8fbfed3cf1e951b4f4c2", "sha256": "e345777e40a3822c4a098933336861d99707dc88fe479453f40cb470f37b196b" }, "downloads": -1, "filename": "afplot-0.2.1.tar.gz", "has_sig": false, "md5_digest": "f43752e34e4a8fbfed3cf1e951b4f4c2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12349, "upload_time": "2017-07-11T11:57:17", "url": "https://files.pythonhosted.org/packages/b7/2d/2052f6bc95f69826c3c82dcc1020f89ad1f6c61ea469944b2389dc67ccdc/afplot-0.2.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "3b097bb241cd99d48917bd92af54ab51", "sha256": "54c1d8de87eb9eb84130aa4d9741f5b1cf3fc3966de554726da63c9499a5f146" }, "downloads": -1, "filename": "afplot-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "3b097bb241cd99d48917bd92af54ab51", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 15275, "upload_time": "2017-07-11T11:57:16", "url": "https://files.pythonhosted.org/packages/d3/f6/c0615986be54594dace49a0e621528a552b54c26b8b5c1de1da057890edb/afplot-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f43752e34e4a8fbfed3cf1e951b4f4c2", "sha256": "e345777e40a3822c4a098933336861d99707dc88fe479453f40cb470f37b196b" }, "downloads": -1, "filename": "afplot-0.2.1.tar.gz", "has_sig": false, "md5_digest": "f43752e34e4a8fbfed3cf1e951b4f4c2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12349, "upload_time": "2017-07-11T11:57:17", "url": "https://files.pythonhosted.org/packages/b7/2d/2052f6bc95f69826c3c82dcc1020f89ad1f6c61ea469944b2389dc67ccdc/afplot-0.2.1.tar.gz" } ] }