PopPUNK (POPulation Partitioning Using Nucleotide Kmers)
Project description
POPulation Partitioning Using Nucleotide Kmers ![](https://pypi-camo.freetls.fastly.net/edffa562fff98a02838cbd00f3359283d4c4efde/646f63732f696d616765732f706f7070756e6b5f76322e706e67)
See our website: https://www.poppunk.net
Description
See the documentation and the paper.
If you find PopPUNK useful, please cite us:
Lees JA, Harris SR, Tonkin-Hill G, Gladstone RA, Lo SW, Weiser JN, Corander J, Bentley SD, Croucher NJ. Fast and flexible bacterial genomic epidemiology with PopPUNK. Genome Research 29:304-316 (2019). doi:10.1101/gr.241455.118
You can also run your command with --citation
to get a list of citations and a
suggested methods paragraph.
News
2021-03-15
We have fixed a number of bugs with may affect the use of poppunk_assign
with
--update-db
. We have also fixed a number of bugs with GPU distances. These are
'advanced' features and are not likely to be encountered in most cases, but if you do wish to use either of these features please make sure that you are using
PopPUNK >=v2.4.0
with pp-sketchlib >=v1.7.0
.
2020-09-30
We have discovered a bug affecting the interaction of pp-sketchlib and PopPUNK.
If you have used PopPUNK >=v2.0.0
with pp-sketchlib <v1.5.1
label order may
be incorrect (see issue #95).
Please upgrade to PopPUNK >=v2.2
and pp-sketchlib >=v1.5.1
. If this is not
possible, you can either:
- Run
scripts/poppunk_pickle_fix.py
on your.dists.pkl
file and re-run model fits. - Create the database with
poppunk_sketch
directly, rather thanPopPUNK --create-db
Installation
This is for the command line version. For more details see installation in the documentation.
There are other interfaces, in-browser and through galaxy, detailed here.
Through conda (recommended)
The easiest way is through conda, which is most easily accessed by first installing miniconda. PopPUNK can then be installed by running:
conda install poppunk
If the package cannot be found you will need to add the necessary channels:
conda config --add channels defaults
conda config --add channels bioconda
conda config --add channels conda-forge
Quick usage
See the quickstart guide for a brief tutorial.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.