sunburst plots for taxonomy
Project description
taxburst: sunburst charts for taxonomy, based on Krona
WARNING: alpha mode software. Use at your own risk.
This is an update of Krona, written with the following goals in mind:
- liberate tax displays from the tyranny of NCBI taxonomy IDs and taxdump;
- support dynamic generation of Krona-style plots;
- rewrite in modern Python;
- support ~nicer multi-stage generation of XHTML;
- probably other things;
The output HTML is derived from Krona, https://github.com/marbl/Krona.
All bugs are mine until proven otherwise.
Please file bugs and feature requests on the issue tracker.
Examples
Here are some examples of (interactive!) taxburst plots:
- small.tax.html - a small example from sourmash.
- SRR606249.x.podar.tax.html - sourmash taxonomy on the SRR606249 defined community.
- SRR11125891.SingleM.html - displaying the results of
singlem pipeon SRR11125891, a pig gut microbiome. - SRR11125891.summarized.html -
sourmashtaxonomic breakdown on SRR11125891. - SRR11125891.tax_annotate.html - genome-resolution taxonomic breakdown of SRR11125891.
A screenshot:
Install
pip install taxburst
Example command lines
All data files are available in the GitHub repository under examples/.
Using sourmash tax metagenome output - summary_csv format
An example using the summary_csv format
from sourmash tax metagenome (see
tax metagenome docs),
taxburst examples/SRR11125891.summarized.csv \
-o pages/SRR11125891.summarized.html
then open pages/SRR11125891.summarized.html in a browser.
Using sourmash tax annotate output
An example using the with-lineages format
from sourmash tax annotate (see
tax annotate docs
taxburst -F tax_annotate \
examples/SRR11125891.t0.gather.with-lineages.csv \
-o pages/SRR11125891.tax_annotate.html
then open pages/SRR11125891.tax_annotate.html in a browser.
Using singleM pipe output
An example using the profile format
from singlem pipe (see
singlem pipe docs):
taxburst -F singleM \
examples/SRR11125891.singleM.profile.tsv \
-o pages/SRR11125891.singleM.html
then open pages/SRR11125891.singleM.html in a browser.
Background and history
Krona is a super cool way to explore taxonomic breakdowns of metagenomes. But it's kind of old, and isn't being actively maintained. Moreover, it doesn't work easily with GTDB or other non-NCBI taxonomies.
So, why not grab the JavaScript code and rewrite the preprocessing code?
Voila! 'taxburst'!
I'd call it Krona2 or something, but the licensing for Krona prohibits that, to my understanding. Hence, 'taxburst'.
Miscellaneous notes on input formats
- the
sourmash tax annotateformat supports assignments down to the genome level, whilesourmash tax metagenome'scsv_summaryformat only goes down to the species level.
Citation information
When using taxburst, please cite the Krona paper: Interactive metagenomic visualization in a Web browser, Ondov et al., 2011.
CTB July 2025
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.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file taxburst-0.1.7.tar.gz.
File metadata
- Download URL: taxburst-0.1.7.tar.gz
- Upload date:
- Size: 60.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.11.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cd668bb9661a5c784961af38fd53f2958a766e4420d9bd10d53ce009d1070347
|
|
| MD5 |
3a6738b2c08147b2b2412a364373fedf
|
|
| BLAKE2b-256 |
beaa6ec8c1644d70975abca312864242cf5af86b676d09e9a40596a0d79e0996
|
File details
Details for the file taxburst-0.1.7-py3-none-any.whl.
File metadata
- Download URL: taxburst-0.1.7-py3-none-any.whl
- Upload date:
- Size: 59.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.11.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cfb41439046bf7b8cd7474dbf8893415e5564955bd2efd38464ddd3fe7dff34f
|
|
| MD5 |
d453fec7ca23609a5d89db6dbb9ee194
|
|
| BLAKE2b-256 |
9ce3f362c12c02a452b189acdeade6296f33291c643d556e674c6d217c432e61
|