Skip to content

theosanderson/taxonium

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

d7df0f1 · Apr 18, 2023
Jul 25, 2022
Jul 25, 2022
Dec 30, 2022
Jan 24, 2023
Nov 17, 2022
Oct 28, 2022
Jan 1, 2023
Apr 18, 2023
Feb 11, 2023
Oct 12, 2022
Sep 27, 2022
Apr 25, 2022
Jul 25, 2022
Jul 5, 2021
Jul 25, 2022
Nov 17, 2022
Sep 16, 2022
Aug 24, 2022
Aug 11, 2022
Mar 9, 2023
Oct 11, 2022

Repository files navigation

Taxonium

Published in eLife All Contributors

Taxonium is a tool for exploring trees, including those with millions of nodes.

How do I..

visualise my own Newick phylogeny?

Upload a Newick file to Taxonium.org, and optionally a metadata file in CSV or TSV format. If using a metadata file the leftmost column must contain names of the nodes as in the tree.

explore the global SARS-CoV-2 phylogeny?

Visit Cov2Tree.org which uses Taxonium to allow you to explore a tree built by researchers at UCSC using public data contributed by researchers across the world to the INSDC databases.

build my own mutation-annotated tree to explore in Taxonium, or add my own metadata to an existing phylogeny?

Use UShER to build a mutation-annotated tree. Then use taxoniumtools to convert it to a Taxonium format you can upload to the interface at Taxonium.org

You can also use taxoniumtools to add your own metadata to the existing public phylogeny.

Find out more in 📚 the documentation.

load really huge trees?

For trees larger than about 6M tips, loading local trees in the browser at Taxonium.org can be unreliable on some systems due to browser memory limitations. To avoid these issues, use the Taxonium desktop app.

See Taxonium in action

Citing Taxonium

Sanderson, T (2022). Taxonium, a web-based tool for exploring large phylogenetic trees. eLife, 11:e82392
https://doi.org/10.7554/eLife.82392

N.B. If you are citing the tree displayed at Cov2Tree.org, please cite the UCSC tree (.. and ideally Taxonium too if you relied on it for exploration)

There is a separate preprint for the Treenome browser.

Structure

Taxonium is structured as a 'monorepo' containing a number of components:

  • taxoniumtools - a Python package that lets you easily generate Taxonium files from Usher protobuf files
  • taxonium_web_client - the web client that is available at e.g. taxonium.org and let's you explore Taxonium files in your browser
  • taxonium_backend - a server-based backend that allows Taxonium trees to be explored without the user downloading the full tree (N.B. Taxonium can also be used without this backend, with static files acccessed in taxonium_web_client)
  • taxonium_data_handling - this is a node package upon which both the web client and the backend depend (it handles core logic common to both)

Contributors

Taxonium development was initiated and is led by Theo Sanderson at the Francis Crick Institute.


Theo Sanderson

💻 📖 🎨 🤔 🚇 🚧

We are very grateful to our contributors:


Alex Kramer

💻 🎨 🤔

Angie Hinrichs

🤔 🔣

Richard Goater

🎨 💻

Chaoran Chen

🤔

Cornelius Roemer

🤔

Sung Kwon

🚇

Koorous Vargha

💻

Alex Kramer at UCSC built the Treenome Browser component within Taxonium, described here.