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, Ondov, Bergman, and Philippy, 2011 link. 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 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 in doc/README.md.

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 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 annotate format supports assignments down to the genome level, while sourmash tax metagenome's csv_summary format 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

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.2.0.tar.gz (62.7 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.2.0-py3-none-any.whl (60.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for taxburst-0.2.0.tar.gz
Algorithm Hash digest
SHA256 0522548b3bba4352137730dcd8d0550003d4ab81e603884f2aa5bfffdff14c66
MD5 bf3e3a1119144e824fa3b41fbcb2f50f
BLAKE2b-256 3c693c81e0fccfe19df06413d8273f62c5fe3c0cc4c038de13427aa4aa00f104

See more details on using hashes here.

File details

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

File metadata

  • Download URL: taxburst-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 60.7 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 80af8e01ba9d5e1f07388641c504c61679d4d0c65df958782839b5b6bb95972a
MD5 e3e9aa45b1d629709cc0c1185b8596b3
BLAKE2b-256 49c6338298841edd005285d8230a0c22458f2b2bf450e6cb4c44c80f6b88e15f

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