Skip to main content

gtdb-itol-decorate

Creates iTOL files for tree decoration, given a set of GTDB genomes.

Installation

pip install gtdb-itol-decorate

Usage

This program requires a taxonomy file (available from the GTDB website), e.g. bac120_taxonomy.tsv, or ar53_taxonomy.tsv.

gtdb_itol_decorate /path/to/tree.tree /path/to/taxonomy.tsv /path/to/output

Output

The program will output the following files.

Note: Typical use will be:

  1. Upload [name_of_input_tree].tree_stripped
  2. Drag the following files into the tree: itol_dataset_strip_phylum.txt, itol_labels.txt, itol_popup.txt, itol_tree_colours.txt
  3. Use the itol_collapse_[rank].txt files to manipulate the view of the tree as desired.

[name_of_input_tree].tree_stripped

This is the tree that you should upload to iTOL. It has been stripped of all internal labels to match the iTOL tree format.

itol_collapse_[rank].txt

When this file is dropped into the iTOL tree, it will collapse all nodes at this rank.

itol_dataset_strip_phylum.txt

This file will create a new colour strip for each phylum.

itol_labels.txt

This will add taxon labels to the tree for both the internal and leaf nodes.

Note: To enable internal labels:

  • Open the "Control panel"
  • Select the "Advanced" tab.
  • Under "Branch metadata display", make sure "Node IDs" is set to "Display".

itol_popup.txt

This creates a popup window when the mouse is hovered over each leaf node. It will display the genome id, and full taxonomy string.

itol_tree_colours.txt

Creates a colour range for each taxon, based on the phylum colour. It will increase in brightness from phylum to species.

Note: This can be changed by altering the "Coloured ranges" popup that will appear after adding this file. In the "Cover" option, "Clade" view is recommended.

Metadata

Release files for gtdb-itol-decorate 1.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gtdb-itol-decorate 1.1.1
File Size Uploaded
gtdb_itol_decorate-1.1.1.tar.gz 21.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for gtdb-itol-decorate 1.1.1
File Interpreter ABI Platform
gtdb_itol_decorate-1.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 43.9 kB

Release files / gtdb_itol_decorate-1.1.1.tar.gz

Download URL gtdb_itol_decorate-1.1.1.tar.gz
Size 21.5 kB
Tags Source
SHA-256 checksum
How to use checksums
0dfbe79e18e12ab746a3b87689ba24740bcf18d2197b31ab3f8af8e5a9dece9f
BLAKE2b-256 checksum
How to use checksums
1fafe3b17b8388554287d3b2947f9eda4fd4b9c10af90d9f58057c320487b66b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.8.18

Release files / gtdb_itol_decorate-1.1.1-py3-none-any.whl

Download URL gtdb_itol_decorate-1.1.1-py3-none-any.whl
Size 22.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cd439eb33d91870ae2ace12854f4b898f6d7ca84a167803bc3451e292c55ae40
BLAKE2b-256 checksum
How to use checksums
e91cd7f949d23b72655d8bdaa129d41eb2354998e7e2aec777969c92858e42d4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.8.18

Release history Release notifications | RSS feed

This release

1.1.1 This release

2 release files

1.1.0

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page