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

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.1.8.tar.gz (62.5 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.8-py3-none-any.whl (60.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: taxburst-0.1.8.tar.gz
  • Upload date:
  • Size: 62.5 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.8.tar.gz
Algorithm Hash digest
SHA256 fb2b0adca39868bb27500d68b10d11f6bc6a4f5309c15196bf2dc4050e083fc5
MD5 28efcc4c65e6bb3211e524cfd549c664
BLAKE2b-256 ae25e6141f3ade95b316395d339427fe97fdd858ad29d9acddfd204eb3043c4b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: taxburst-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 60.5 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 3dc7a48a38831b567c032feb7fc8d236690f3d8ecce0497650bb9e280cd7d236
MD5 3ff356b2ebbfb85b9222384ad6c9aa67
BLAKE2b-256 66cfa3db623292d2c4df48c7e6a332f1d59cd569d4740c66d8a12e95e7e48548

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