Skip to main content

Running AMRFinderPlus for MDU

Project description

CI GitHub release License: GPL v3 Conda DOI

Taming the AMR beast

abriTAMR is an AMR gene/variant detection pipeline that runs AMRFinderPlus on bacteiral genome assemblues, categorises the variants into reportable/not-reportable, and sorts into clinical drug classes.

abriTAMR is accredited by NATA for use in identifying the presence of reportable AMR genes the MDU PHL in Victoria, Australia.

Installation

% conda create -n abritamr -c bioconda abritamr
% conda activate abritamr
% abritamr --version

Quick start

% abritamr run -c genome.fasta

% ls abritamr
abritamr.log         summary_partials.txt
amrfinder.out        summary_virulence.txt
summary_matches.txt  update_abritamr_db.log

% cat abritamr/abritamr.txt
Isolate	Methicillin	Tetracycline	Tigecycline	Beta-lactam	Penicillin resistance (Staphylococcus aureus)
abritamr	mecA,mecR1^	tet(38)*	mepA*	blaI*,blaR1*	blaZ

Input

The -c option is used for input, and can accept 2 types of files:

  1. a single FASTA file, usually a genome assembly:
>contug001
AGTCTCGATATGCTATAGGCTTATATATAT
ATGCTATAGGCTTATATATATTTATATCTT
>contig002
CGATATGCTATAGGCTTATATATATTTATA
...
  1. a TSV file for multiple FASTA files:
ID1 <tab> /path/to/assembly1.fasta
ID2 <tab> /path/to/second/file.fna
...

Running

abritamr run --help


optional arguments:
  -h, --help            show this help message and exit
  --contigs CONTIGS, -c CONTIGS
                        Tab-delimited file with sample ID as column 1 and path to assemblies as column 2 OR path to a contig
                        file (used if only doing a single sample - should provide value for -pfx). (default: )
  --prefix PREFIX, -px PREFIX
                        If running on a single sample, please provide a prefix for output directory (default: abritamr)
  --jobs JOBS, -j JOBS  Number of AMR finder jobs to run in parallel. (default: 16)
  --identity IDENTITY, -i IDENTITY
                        Set the minimum identity of matches with amrfinder (0 - 1.0). Defaults to amrfinder preset, which is 0.9
                        unless a curated threshold is present for the gene. (default: )
  --amrfinder_db AMRFINDER_DB, -d AMRFINDER_DB
                        Path to amrfinder DB to use (default:
                        /<path_to_installation>/abritamr/abritamr/db/amrfinderplus/data/2021-09-30.1)
  --species {Neisseria,Clostridioides_difficile,Acinetobacter_baumannii,Campylobacter,Enterococcus_faecalis,Enterococcus_faecium,Escherichia,Klebsiella,Salmonella,Staphylococcus_aureus,Staphylococcus_pseudintermedius,Streptococcus_agalactiae,Streptococcus_pneumoniae,Streptococcus_pyogenes}, -sp {Neisseria,Clostridioides_difficile,Acinetobacter_baumannii,Campylobacter,Enterococcus_faecalis,Enterococcus_faecium,Escherichia,Klebsiella,Salmonella,Staphylococcus_aureus,Staphylococcus_pseudintermedius,Streptococcus_agalactiae,Streptococcus_pneumoniae,Streptococcus_pyogenes}
                        Set if you would like to use point mutations, please provide a valid species. (default: )

You can also run abriTAMR in report mode, this will output a spreadsheet which is based on reportable/not-reportable requirements in Victoria. You will need to supply a quality control file (comma separated) (-q), with the following columns:

  • ISOLATE
  • SPECIES_EXP (the species that was expected)
  • SPECIES_OBS (the species that was observed during the quality control analysis)
  • TEST_QC (PASS or FAIL)

--sop refers to the type of collation and reporting pipeline

  • general
    • standard reporting structure for aquired genes, output as reportable and non-reportable
  • plus
    • Inferred AST based on validation undertaken at MDU
abritamr report --help

optional arguments:
  -h, --help            show this help message and exit
  --qc QC, -q QC        Name of checked MDU QC file. (default: )
  --runid RUNID, -r RUNID
                        MDU RunID (default: Run ID)
  --matches MATCHES, -m MATCHES
                        Path to matches, concatentated output of abritamr (default: summary_matches.txt)
  --partials PARTIALS, -p PARTIALS
                        Path to partial matches, concatentated output of abritamr (default: summary_partials.txt)
  --sop {general,plus}  The MDU pipeline for reporting results. (default: general)

Output

abritAMR run

Outputs 4 summary files and retains the raw AMRFinderPlus output for each sequence input.

  1. amrfinder.out raw output from AMRFinder plus (per sequence). For more information please see AMRFinderPlus help here

  2. summary_matches.txt

  • Tab-delimited file, with a row per sequence, and columns representing functional drug classes

  • Only genes recovered from sequence which have >90% coverage of the gene reported and greater than the desired identity threshold (default 90%).

    I. Genes annotated with * indicate >90% coverage and > identity threshold < 100% identity.

    II. No further annotation indicates that the gene recovered exhibits 100% coverage and 100% identity to a gene in the gene catalog.

    III. Point mutations detected (if --species supplied) will also be present in this file in the form of gene_AAchange.

  1. summary_partials.txt
  • Tab-delimited file, with a row per sequence, and columns representing functional drug classes
  • Genes recovered from sequence which have >50% but <90% coverage of the gene reported and greater than the desired identity threshold (default 90%).
  1. summary_virulence.txt
  • Tab-delimited file, with a row per sequence, and columns representing AMRFinderPlus virulence gene classification

  • Genes recovered from sequence which have >50% coverage of the gene reported and greater than the desired identity threshold (default 90%).

    • Genes recovered with >50% but <90% coverage of a gene in the gene catalog will be annotated with ^.
    • Genes annotated with * indicate >90% coverage and > identity threshold < 100% identity.
  1. abritamr.txt
  • Tab-delimited file, combining summary_matches.txt, summary_partials.txt, summary_virulence.txt with a row per sequence, and columns representing AMRFinderPlus virulence gene classification and/or functional drug classes.

  • Genes recovered from sequence which have >50% coverage of the gene reported and greater than the desired identity threshold (default 90%).

    • Genes recovered with >50% but <90% coverage of a gene in the gene catalog will be annotated with ^.
    • Genes annotated with * indicate >90% coverage and > identity threshold < 100% identity.

abritamr report

will output spreadsheets general_runid.xlsx (NATA accredited) or plus_runid.xlsx (validated - not yet accredited) depending upon the sop chosen.

  • general_rundid.xlsx has two tabs, one for matches and one for partials (corresponding to genes reported in the summary_matches.txt and summary_partials.txt). Each tab has 7 columns
Column Interpretation
MDU sample ID Sample ID
Item code suffix (MDU specific)
Resistance genes (alleles) detected genes detected that are reportable (based on species and drug classification)
Resistance genes (alleles) det (non-rpt) other genes detected that are not not reportable for the species detected.
Species_obs Species observed (supplied in input file)
Species_exp Species expected (supplied in input file)
db_version Version of the AMRFinderPlus DB used
  • plus_runid.xlsx output is a spreadsheet with the different drug resistance mechanims and the corresponding interpretation (based on validation of genotype and phenotype) for drug-classes relevant to reporting of anti-microbial resistance in Salmonella enterica (other species will be added as validation of genotype vs phenotype is performed).

  • Ampicillin

  • Cefotaxime (ESBL)

  • Cefotaxime (AmpC)

  • Tetracycline

  • Gentamicin

  • Kanamycin

  • Streptomycin

  • Sulfathiazole

  • Trimethoprim

  • Trim-Sulpha

  • Chloramphenicol

  • Ciprofloxacin

  • Meropenem

  • Azithromycin

  • Aminoglycosides (RMT)

  • Colistin

References

Feedback

File questions, bugs, or ideas on the Issues page

License

GPLv3

Citation

Sherry, N.L., Horan, K.A., ... , Seemann, T. An ISO-certified genomics workflow for identification and surveillance of antimicrobial resistance Nat Commun 14;60 (2023). DOI:10.1038/s41467-022-35713-4 PMID:36599823

Authors

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

abritamr-1.2.0.tar.gz (50.9 MB view details)

Uploaded Source

Built Distribution

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

abritamr-1.2.0-py3-none-any.whl (44.4 MB view details)

Uploaded Python 3

File details

Details for the file abritamr-1.2.0.tar.gz.

File metadata

  • Download URL: abritamr-1.2.0.tar.gz
  • Upload date:
  • Size: 50.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for abritamr-1.2.0.tar.gz
Algorithm Hash digest
SHA256 784cf71a2a58adea6263fea07a6810bb0fe701dda5e316f454f906f274ec7e8a
MD5 58ca3b5ffd98062428885d63ac0f101a
BLAKE2b-256 1de563183e84e77eaea00ed9dfd7076a946a7b436ec8089c2c3d737972d016c4

See more details on using hashes here.

File details

Details for the file abritamr-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: abritamr-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 44.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for abritamr-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 36ec36f235f04449577fa324d4185df8d6b5d64ffa40a9f83086d33681b354f3
MD5 bce29c13fdb9b528ddb4aaad6770aa62
BLAKE2b-256 81ed7630a5d204d9872ae524488ff91d6d41e0ecd889cdeac7b8c7c0d7b5fb0f

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