Skip to main content

sunburst plots for taxonomy

Project description

taxburst: sunburst charts for taxonomy, based on Krona

taxburst is a fork of the Krona software, (see: Ondov, Bergman, and Philippy, 2011). It produces static HTML pages that provide an interactive display of a metagenomic taxonomy.

Here is an example screenshot:

example output screenshot

Krona is a fantastic piece of software, but it has been unmaintained for a number of years. Moreover, the input parsing code is written in Perl and the default instructions require use of NCBI taxids.

The goal of taxburst is to update Krona to a maintained, documented piece of software that can be adapted and adjusted in a variety of ways. This is still alpha mode software, to be used at your own risk.

Please file bugs and feature requests on the issue tracker.

Pull requests are welcome!

Additional documentation

More documentation is available at taxburst.github.io/taxburst/.

Examples

Here are some examples of (interactive!) taxburst plots:

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 SRR11125891.summarized.html

then open 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 SRR11125891.tax_annotate.html

then open 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 SRR11125891.singleM.html

then open 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'.

Citation information

When using taxburst, please cite the Krona paper: Interactive metagenomic visualization in a Web browser, Ondov et al., 2011.


CTB July 2025

ctbrown@ucdavis.edu

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

taxburst-0.3.0.tar.gz (64.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

taxburst-0.3.0-py3-none-any.whl (62.9 kB view details)

Uploaded Python 3

File details

Details for the file taxburst-0.3.0.tar.gz.

File metadata

  • Download URL: taxburst-0.3.0.tar.gz
  • Upload date:
  • Size: 64.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.8

File hashes

Hashes for taxburst-0.3.0.tar.gz
Algorithm Hash digest
SHA256 ae031b5c0cf71e8d9ee8125c727df4d6dfb1babb1cc6f04a1064a4f454359a72
MD5 850158f863a1b952c608e2088d1b907e
BLAKE2b-256 1db7ce1624c46553906ca392ea351714de8085ec7ada8bc62e940d5c00ad6c04

See more details on using hashes here.

File details

Details for the file taxburst-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: taxburst-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 62.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.8

File hashes

Hashes for taxburst-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4c94d63f0879b1db60b12022fb4d8e01aaa9ddea75dc8739e6b104289cc6ce7a
MD5 8ed99082062bd234f3961f2d05e7e319
BLAKE2b-256 9d7cc5ee4203c5ebdd9e783a70e576dc42311ca041d3aa966e0cbe95fa3bc1c4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page