Skip to main content

sunburst plots for taxonomy

Project description

taxburst: sunburst charts for taxonomy, based on Krona

PyPI install with bioconda

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!

Documentation

User and developer documentation is available at taxburst.github.io/taxburst/.

Examples

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

Install

Via pypi

pip install taxburst

or from bioconda

conda create -n taxburst -c bioconda taxburst
conda activate 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.1.tar.gz (64.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.3.1-py3-none-any.whl (62.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: taxburst-0.3.1.tar.gz
  • Upload date:
  • Size: 64.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.3.1.tar.gz
Algorithm Hash digest
SHA256 4733d5de39f700abe53fbc71a6934e46edb7aec59421b72e5c962487948cbc30
MD5 e29700d53f86e5e56bdc7e74ff8f4798
BLAKE2b-256 124b10d5dd5eb3b9495b4ff9882649f94c943ea9b0aa26dc8f40366a01dceccd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: taxburst-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 62.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.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7600662ce05bd6ded5f4dee07c78f604059f463ff5696482051fa68a4c9d8fc9
MD5 f533bc279a0d132fd81a0f1b09594be1
BLAKE2b-256 ab1716728841eca37a46701a85b60a8ed16d5aec81c2e757a29452150561beff

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