Skip to content
/ GTDBTk Public
forked from Ecogenomics/GTDBTk

GTDB-Tk: a toolkit for assigning objective taxonomic classifications to bacterial and archaeal genomes.

License

Notifications You must be signed in to change notification settings

AroneyS/GTDBTk

 
 

Repository files navigation

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.2.0+ includes the following new features:

  • GTDB-TK classify and classify_wf have changed in version 2.2.0+. There is now an ANI classification stage (ANI screen) that precedes classification by placement in a reference tree.
    • This is now the default behavior for classify and classify_wf.
    • In classify, user genomes are first compared against a Mash database comprised of all GTDB representative genomes and genome pairs of sufficient similarity processed by FastANI. User genomes classified to a GTDB representative based on FastANI results are not run through pplacer.
    • In the classify_wf workflow, genomes are classified using Mash and FastANI before executing the identify step. User genomes classified with FastANI are not run through the remainder of the pipeline (identify, align, classify).
    • classify_wf and classify have now an extra mutually exclusive required argument: You can either pick --skip_ani_screen (to skip the ani_screening step to classify genomes using mash and FastANI) or --mash_db path to save/read (if exists) the Mash reference sketch database.
    • To classify genomes without the additional ani_screen step, use the --skip_ani_screen flag.

📈 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.

About

GTDB-Tk: a toolkit for assigning objective taxonomic classifications to bacterial and archaeal genomes.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.6%
  • Other 0.4%