Skip to main content

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

Project description

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.

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

gtdb_itol_decorate-1.1.1.tar.gz (21.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gtdb_itol_decorate-1.1.1-py3-none-any.whl (22.4 kB view details)

Uploaded Python 3

File details

Details for the file gtdb_itol_decorate-1.1.1.tar.gz.

File metadata

  • Download URL: gtdb_itol_decorate-1.1.1.tar.gz
  • Upload date:
  • Size: 21.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.8.18

File hashes

Hashes for gtdb_itol_decorate-1.1.1.tar.gz
Algorithm Hash digest
SHA256 0dfbe79e18e12ab746a3b87689ba24740bcf18d2197b31ab3f8af8e5a9dece9f
MD5 74cb1c3801baf8d1c9cb8f52e7754f41
BLAKE2b-256 1fafe3b17b8388554287d3b2947f9eda4fd4b9c10af90d9f58057c320487b66b

See more details on using hashes here.

File details

Details for the file gtdb_itol_decorate-1.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for gtdb_itol_decorate-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cd439eb33d91870ae2ace12854f4b898f6d7ca84a167803bc3451e292c55ae40
MD5 c4cb35901c35b408be60b54618d10645
BLAKE2b-256 e91cd7f949d23b72655d8bdaa129d41eb2354998e7e2aec777969c92858e42d4

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