Skip to main content

A toolkit for assigning objective taxonomic classifications to bacterial and archaeal genomes.

Project description

GTDB-Tk

PyPI PyPI Downloads Bioconda BioConda Downloads Docker Image Version (latest by date) Docker Pulls

GTDB-Tk is a software toolkit for assigning objective taxonomic classifications to bacterial and archaeal genomes based on the Genome Database Taxonomy (GTDB). It is designed to work with recent advances that allow hundreds or thousands of metagenome-assembled genomes (MAGs) to be obtained directly from environmental samples. It can also be applied to isolate and single-cell genomes. The GTDB-Tk is open source and released under the GNU General Public License (Version 3).

Notifications about GTDB-Tk releases will be available through the GTDB Twitter account and the GTDB Announcements Forum.

Please post questions and issues related to GTDB-Tk on the Issues section of the GitHub repository. Questions related to the GTDB can be posted on the GTDB Forum or sent to the GTDB team.

🚀 Getting started

Be sure to check the hardware requirements, then choose your preferred method:

📖 Documentation

Documentation for GTDB-Tk can be found here.

✨ New Features

GTDB-Tk v2.7.0+ includes the following new features:

  • Pre-sketched skani database: GTDB-Tk now uses a skani pre-sketched database of the GTDB representative genomes. This significantly reduces the database storage footprint from 198 GB (in Release 232) down to 98 GB.
  • Representative genomes availability: The GTDB representative genomes are now available via the "Download" page on the GTDB website.
  • Deprecated flag: Because the database is already sketched natively, the --skani_sketch_dir flag is now deprecated.
  • Replaced --skip_ani_screen with --place_species: The --skip_ani_screen flag is now deprecated in v2.7.0 and has been replaced by the --place_species flag. The logic has been updated to reflect the new database structure:
    • Previously: Using --skip_ani_screen, genomes placed in a genus by pplacer were only compared to representative genomes within that specific genus.
    • Now: Because the database is a single skani sketch, user genomes are compared against all GTDB reference genomes once at the very beginning of the pipeline. When the new --place_species flag is selected, the genomes are still explicitly placed in the reference tree.

⚠️ IMPORTANT MEMORY WARNING: The divide-and-conquer approach now requires more than 128 GB of RAM. Specifically, you will need at least 140 GB of RAM for R232.

📈 Performance

Using ANI screen "can" reduce computation by >50%, although it depends on the set of input genomes. A set of input genomes consisting primarily of new species will not benefit from ANI screen as much as a set of genomes that are largely assigned to GTDB species clusters. In the latter case, the ANI screen will reduce the number of genomes that need to be classified by pplacer which reduces computation time substantially (between 25% and 60% in our testing).

📚 References

GTDB-Tk is described in:

The Genome Taxonomy Database (GTDB) is described in:

We strongly encourage you to cite the following 3rd party dependencies:

© Copyright

Copyright 2017 Pierre-Alain Chaumeil. See LICENSE for further details.

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

gtdbtk-2.7.2.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

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

gtdbtk-2.7.2-py3-none-any.whl (1.8 MB view details)

Uploaded Python 3

File details

Details for the file gtdbtk-2.7.2.tar.gz.

File metadata

  • Download URL: gtdbtk-2.7.2.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.18

File hashes

Hashes for gtdbtk-2.7.2.tar.gz
Algorithm Hash digest
SHA256 786493c1b89a83b73e6b77d82eb8d0e0e1f0df0e2540b1a6f2ba334b82b172cc
MD5 6648bae55d3d573f05c4a8aa45c12195
BLAKE2b-256 de6106115b464b069609b06c722fe412edc27aaec7a7fafa0fa2f57fae938846

See more details on using hashes here.

File details

Details for the file gtdbtk-2.7.2-py3-none-any.whl.

File metadata

  • Download URL: gtdbtk-2.7.2-py3-none-any.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.18

File hashes

Hashes for gtdbtk-2.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 238403e9b61000bf6919dd67015b705928188852b9235654abbff03f915f0cf3
MD5 d528919ce304f77df6db3ce7e1ff0d66
BLAKE2b-256 088ec9ee40179a650081d9ca0ac730daf0de46df30c9aa5cb5b78bcc0614a85a

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