Skip to main content

software tool designed to accurately identify the genetic translation table (GTT) used in prokaryotic organisms.

Project description

gTranslate

gTranslate is a machine learning-based command-line tool for predicting the translation table (TT) used by prokaryotic genomes. By analyzing specific sequence features — such as coding density differences, Trp ratios, and Gly ratios — gTranslate can accurately distinguish between the genetic codes associated with reassignment of the UGA stop codon, i.e. translation tables 11 (standard prokaryotic code), 4 (UGA=Trp), and 25 (UGA=Gly).

Features

  • Automated Table Detection: Rapidly predict the correct translation table for a single genome or large batches of genomes.
  • Interactive Visualizations: Generate dynamic HTML dashboards to explore the feature space used by the classifiers.

Installation

gTranslate requires Python >= 3.12 and Prodigal >= 2.6.2 on your system path.

Option 1: Bioconda (Recommended)

We recommend using Mamba for a faster setup:

conda create -n gtranslate -c conda-forge -c bioconda gtdb-gtranslate
conda activate gtranslate

Option 2: pip

It is recommended to use a virtual environment:

# Install
python -m pip install -i https://test.pypi.org/simple/ gtdb-gtranslate

# Upgrade
python -m pip install -i https://test.pypi.org/simple/ --upgrade gtdb-gtranslate

Usage

gTranslate is operated via two subcommands: detect_table and generate_plot.

You can view the general help menu at any time:

gtranslate -h

Detect table

The core pipeline for detecting the translation table used by prokaryotic organisms. You must provide input genomes either via a directory or a batch file.

Basic Usage:

# Process a directory of genomic FASTA files
gtranslate detect_table --genome_dir /path/to/genomes --out_dir /path/to/output

# Process genomic FASTA files defined in a batch file
gtranslate detect_table --batchfile genomes.tsv --out_dir /path/to/output

The file provided to --batchfile is a two-column, tab-separated values (TSV) file that indicates the path to the genomic FASTA file and the desired genome identifier, e.g.:

/example/path/GCF_001729785.1_ASM172978v1/GCF_001729785.1.fna.gz      G001729785
/a/different/path/GCF_043834535.1.fna.gz    G043834535
...

Generate plot (optional)

Generates an interactive HTML dashboard to visually explore the features (e.g., coding density difference, amino acid ratios) used by gTranslate to predict the translation table.

Basic Usage:

gtranslate generate_plot --feature_file features.tsv --output_file dashboard.html

The file features.tsv provided to --feature_file is generated by the detect_table command.

Testing

Validation that gTranslate has been installed correctly and is operating as expected can be done using the check_install and test subcommands:

Check installation

Verifies your installation and ensures that all required dependencies and reference data files are correctly configured and present.

Basic Usage:

gtranslate check_install

Test operation of gTranslate

Runs the built-in test suite on bundled genomic data to validate that gTranslate is functioning correctly on your system.

Basic Usage:

gtranslate test --cpus 4

Note: If --out_dir is not specified, the test will securely execute in a temporary directory.

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_gtranslate-0.0.3.tar.gz (75.4 kB view details)

Uploaded Source

Built Distribution

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

gtdb_gtranslate-0.0.3-py3-none-any.whl (102.2 kB view details)

Uploaded Python 3

File details

Details for the file gtdb_gtranslate-0.0.3.tar.gz.

File metadata

  • Download URL: gtdb_gtranslate-0.0.3.tar.gz
  • Upload date:
  • Size: 75.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for gtdb_gtranslate-0.0.3.tar.gz
Algorithm Hash digest
SHA256 0b5f8168d76f1ee31ddc81561180270f2a942658465a8a808b674504bfb678ed
MD5 828b577979b0c91d907b38c8dcd02fc0
BLAKE2b-256 e24a54331555f7157fa4c6254bd7c4c5881a92072bef14c17d947406de84dc8c

See more details on using hashes here.

Provenance

The following attestation bundles were made for gtdb_gtranslate-0.0.3.tar.gz:

Publisher: release-publish.yml on cmc-aau/gTranslate

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gtdb_gtranslate-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: gtdb_gtranslate-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 102.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for gtdb_gtranslate-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 00512cbb2c888293044ec76ebf9aae02c9161692e7210b2507c53d5fb55a39a3
MD5 c5ff7e14695196dd4ec54d9f182dd2c5
BLAKE2b-256 fa9e136cba2d6b548851e85304326ebdb59bf0270dc4ee8912d8812fe8185f3a

See more details on using hashes here.

Provenance

The following attestation bundles were made for gtdb_gtranslate-0.0.3-py3-none-any.whl:

Publisher: release-publish.yml on cmc-aau/gTranslate

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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