Skip to main content

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:

A screenshot:

example output 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'.

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.1.5.tar.gz (59.2 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.1.5-py3-none-any.whl (57.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for taxburst-0.1.5.tar.gz
Algorithm Hash digest
SHA256 8da49bfc29d99d56d01dbe71145066517507d0a909efc67d1795e97506a92b63
MD5 03df91502f2395957d52a37e328c5ee6
BLAKE2b-256 33c6c9ba9e8cab6fc54c5efdf055813060281bf800837089406f1385cf8bbf0b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: taxburst-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 57.8 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.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 2da6a2d6b0b0638c6ec2530e40ca3ed7b69fecd9fb7c93f83e57f64c838d0427
MD5 3bf719eef274735ceb60e3cdc881d4fd
BLAKE2b-256 2e54e092f073542ae3da561495e2e341140f63ceee2709943ac2c064663c014b

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