Skip to main content

Automated discovery and curation of Auxiliary Metabolic Genes (AMGs), Auxiliary Regulatory Genes (AReGs), and Auxiliary Physiology Genes (APGs) encoded by viral genomes.

Project description

CheckAMG

Automated discovery and curation of Auxiliary Metabolic Genes (AMGs), Auxiliary Regulatory Genes (AReGs), and Auxiliary Physiology Genes (APGs) encoded by viral genomes

This tool is in active development and has not yet been peer-reviewed.

CheckAMG identifies and curates high-confidence auxiliary viral genes (AVGs) using two complementary approaches: a reference-based path (curated functional annotations plus viral genome context) and a reference-independent path (the Protein Set Transformer genome language model).

Quick usage

checkamg download -d /path/to/db/destination

checkamg end-to-end \
  -d /path/to/db/destination \
  -i examples/example_data/single_contig_viruses.fasta \
  -I examples/example_data/multi_contig_vMAGs \
  -o CheckAMG_example_out

Features

  • Input: nucleotide or protein sequences
  • Handles single-contig viral genomes and multi-contig vMAGs/bins
  • Reference-based annotation and genome-context curation (annotate)
  • Reference-independent prediction with a protein genome language model (de-novo)
  • Combined reporting (aggregate) and one-command runs (end-to-end)
  • Outputs curated lists and amino-acid sequences of AMGs, AReGs, and APGs

Modules

checkamg -h
  • download: get the required databases
  • annotate: reference-based AVG prediction and curation
  • de-novo: reference-independent AVG prediction with PST
  • aggregate: merge annotate and de-novo results
  • end-to-end: run annotate, de-novo, and aggregate in tandem
  • train: finetune a custom CheckAMG-PST model

License

GPL-3.0-or-later

Installation, example data, and full documentation: https://github.com/AnantharamanLab/CheckAMG and the CheckAMG Wiki.

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

checkamg-1.0.tar.gz (16.6 MB view details)

Uploaded Source

File details

Details for the file checkamg-1.0.tar.gz.

File metadata

  • Download URL: checkamg-1.0.tar.gz
  • Upload date:
  • Size: 16.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.3

File hashes

Hashes for checkamg-1.0.tar.gz
Algorithm Hash digest
SHA256 2e71e7e7e164e9eefc2f0ba1f088d7ab9e5ad7398ba7b7a06f965a0d7fd62f83
MD5 d24e860ddfb9b334802a07dabae778f4
BLAKE2b-256 04e560e551bcbd1707ba4987ac69a919edb9181b869388561fb4ae0c6a1d0360

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