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:
- a single FASTA file, usually a genome assembly:
>contug001
AGTCTCGATATGCTATAGGCTTATATATAT
ATGCTATAGGCTTATATATATTTATATCTT
>contig002
CGATATGCTATAGGCTTATATATATTTATA
...
- 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.
-
amrfinder.outraw output from AMRFinder plus (per sequence). For more information please see AMRFinderPlus help here -
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
--speciessupplied) will also be present in this file in the form ofgene_AAchange.
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%).
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.
- Genes recovered with >50% but <90% coverage of a gene in the gene catalog will be annotated with
abritamr.txt
-
Tab-delimited file, combining
summary_matches.txt,summary_partials.txt,summary_virulence.txtwith 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.
- Genes recovered with >50% but <90% coverage of a gene in the gene catalog will be annotated with
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.xlsxhas two tabs, one for matches and one for partials (corresponding to genes reported in thesummary_matches.txtandsummary_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.xlsxoutput 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
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
- Kristy Horan
- Torsten Seemann
- Norelle Sherry
- CHarlie Higgs (logo design)
Metadata
Release files for abritamr 1.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| abritamr-1.3.0.tar.gz | 51.0 MB | Without provenance | Details for abritamr-1.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| abritamr-1.3.0-py3-none-any.whl | Python 3 | none | any | Details for abritamr-1.3.0-py3-none-any.whl |
Total release size: 95.5 MB
Release files / abritamr-1.3.0.tar.gz
| Download URL | abritamr-1.3.0.tar.gz |
|---|---|
| Size | 51.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bd50ff72f8ca4d2a6e08c14058d6c98ec85931233fe85683e21abe402fb1a353
|
|
BLAKE2b-256 checksum How to use checksums |
d0ddbfe33492954157317d1e0c75c35eee1a06f58cdb754c928fed18b1dae2a1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.2
|
Release files / abritamr-1.3.0-py3-none-any.whl
| Download URL | abritamr-1.3.0-py3-none-any.whl |
|---|---|
| Size | 44.5 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b2beba0614180e0cf686412e991accac6558ec3d77165fb16f28e6d89d2f060c
|
|
BLAKE2b-256 checksum How to use checksums |
a39def514f8ab0271e12e7897b8473a9978dc2234093075d808c8753dcd5ee01
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.2
|
Security for abritamr 1.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.