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:
- Upload
[name_of_input_tree].tree_stripped - Drag the following files into the tree:
itol_dataset_strip_phylum.txt,itol_labels.txt,itol_popup.txt,itol_tree_colours.txt - Use the
itol_collapse_[rank].txtfiles 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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0dfbe79e18e12ab746a3b87689ba24740bcf18d2197b31ab3f8af8e5a9dece9f
|
|
| MD5 |
74cb1c3801baf8d1c9cb8f52e7754f41
|
|
| BLAKE2b-256 |
1fafe3b17b8388554287d3b2947f9eda4fd4b9c10af90d9f58057c320487b66b
|
File details
Details for the file gtdb_itol_decorate-1.1.1-py3-none-any.whl.
File metadata
- Download URL: gtdb_itol_decorate-1.1.1-py3-none-any.whl
- Upload date:
- Size: 22.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.8.18
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cd439eb33d91870ae2ace12854f4b898f6d7ca84a167803bc3451e292c55ae40
|
|
| MD5 |
c4cb35901c35b408be60b54618d10645
|
|
| BLAKE2b-256 |
e91cd7f949d23b72655d8bdaa129d41eb2354998e7e2aec777969c92858e42d4
|