Skip to content

Commit 5068641

Browse files
Merge pull request #1166 from Kincekara/master
update amrfinder 4.0.3 & 2024-12-18.1
2 parents c032b57 + 5fe89fc commit 5068641

File tree

3 files changed

+171
-1
lines changed

3 files changed

+171
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ To learn more about the docker pull rate limits and the open source software pro
232232
| [NanoPlot](https://hub.docker.com/r/staphb/nanoplot) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/nanoplot)](https://hub.docker.com/r/staphb/nanoplot) | <ul><li>[1.27.0](./nanoplot/1.27.0/)</li><li>[1.29.0](./nanoplot/1.29.0/)</li><li>[1.30.1](./nanoplot/1.30.1/)</li><li>[1.32.0](./nanoplot/1.32.0/)</li><li>[1.33.0](./nanoplot/1.33.0/)</li><li>[1.40.0](./nanoplot/1.40.0/)</li><li>[1.41.6](./nanoplot/1.41.6/)</li><li>[1.42.0](./nanoplot/1.42.0/)</li></ul> | https://github.com/wdecoster/NanoPlot |
233233
| [ngmaster](https://hub.docker.com/r/staphb/ngmaster) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/ngmaster)](https://hub.docker.com/r/staphb/ngmaster) | <ul><li>0.5.8</li><li>1.0.0</li></ul> | https://github.com/MDU-PHL/ngmaster |
234234
| [NCBI Datasets](https://hub.docker.com/r/staphb/ncbi-datasets) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/ncbi-datasets)](https://hub.docker.com/r/staphb/ncbi-datasets) | <details><summary> Click to see all datasets versions </summary> **datasets versions** <ul><li>[13.31.0](./ncbi-datasets/13.31.0/)</li><li>[13.35.0](./ncbi-datasets/13.35.0/)</li><li>[13.43.2](./ncbi-datasets/13.43.2/)</li><li>[14.0.0](./ncbi-datasets/14.0.0/)</li><li>[14.3.0](./ncbi-datasets/14.3.0/)</li><li>[14.7.0](./ncbi-datasets/14.7.0/)</li><li>[14.13.2](./ncbi-datasets/14.13.2/)</li><li>[14.20.0](./ncbi-datasets/14.20.0/)</li><li>[14.27.0](ncbi-datasets/14.27.0/)</li><li>[15.1.0](ncbi-datasets/15.1.0/)</li><li>[15.2.0](ncbi-datasets/15.2.0/)</li><li>[15.11.0](ncbi-datasets/15.11.0/)</li><li>[15.27.1](ncbi-datasets/15.27.1/)</li><li>[15.31.0](ncbi-datasets/15.31.1/)</li><li>[16.2.0](ncbi-datasets/16.2.0/)</li><li>[16.8.1](./ncbi-datasets/16.8.1/)</li><li>[16.10.3](./ncbi-datasets/16.10.3/)</li><li>[16.15.0](./ncbi-datasets/16.15.0/)</li><li>[16.22.1](./ncbi-datasets/16.22.1/)</li><li>[16.30.0](./ncbi-datasets/16.30.0/)</li><li>[16.35.0](ncbi-datasets/16.35.0/)</li></ul> | [https://github.com/ncbi/datasets](https://github.com/ncbi/datasets) <br/>[https://www.ncbi.nlm.nih.gov/datasets/docs/v1/](https://www.ncbi.nlm.nih.gov/datasets/docs/v1/) |
235-
| [NCBI AMRFinderPlus](https://hub.docker.com/r/staphb/ncbi-amrfinderplus) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/ncbi-amrfinderplus)](https://hub.docker.com/r/staphb/ncbi-amrfinderplus) | **AMRFinderPlus & database verion** <details><summary> Click to see AMRFinderplus v3.11.4 and older versions! </summary> <ul><li>3.1.1b</li><li>3.8.4</li><li>3.8.28</li><li>3.9.3</li><li>3.9.8</li><li>3.10.1</li><li>3.10.5</li><li>3.10.16</li><li>3.10.20</li><li>3.10.24</li><li>3.10.30</li><li>3.10.36</li><li>3.10.42</li><li>3.11.2 & 2022-12-19.1</li><li>[3.11.2 & 2023-02-23.1](ncbi-amrfinderplus/3.11.2-2023-02-23.1/)</li><li>[3.11.4 & 2023-02-23.1](ncbi-amrfinderplus/3.11.4-2023-02-23.1/)</li></ul> </details> <ul><li>[3.11.8 & 2023-02-23.1](ncbi-amrfinderplus/3.11.8-2023-02-23.1/)</li><li>[3.11.11 & 2023-04-17.1](ncbi-amrfinderplus/3.11.11-2023-04-17.1)</li><li>[3.11.14 & 2023-04-17.1](ncbi-amrfinderplus/3.11.14-2023-04-17.1/)</li><li>[3.11.17 & 2023-07-13.2](ncbi-amrfinderplus/3.11.17-2023-07-13.2/)</li><li>[3.11.18 & 2023-08-08.2](ncbi-amrfinderplus/3.11.18-2023-08-08.2/)</li><li>[3.11.20 & 2023-09-26.1](ncbi-amrfinderplus/3.11.20-2023-09-26.1/)</li><li>[3.11.26 & 2023-11-15.1](ncbi-amrfinderplus/3.11.26-2023-11-15.1/)</li><li>[3.12.8 & 2024-01-31.1](ncbi-amrfinderplus/3.12.8-2024-01-31.1/)</li><li>[3.12.8 & 2024-05-02.2](./ncbi-amrfinderplus/3.12.8-2024-05-02.2/)</li><li>[3.12.8 & 2024-07-22.1](./ncbi-amrfinderplus/3.12.8-2024-07-22.1/)</li><li>[4.0.3 & 2024-10-22.1 (includes stxtyper)](./ncbi-amrfinderplus/4.0.3-2024-10-22.1/)</li></ul> | [https://github.com/ncbi/amr](https://github.com/ncbi/amr) |
235+
| [NCBI AMRFinderPlus](https://hub.docker.com/r/staphb/ncbi-amrfinderplus) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/ncbi-amrfinderplus)](https://hub.docker.com/r/staphb/ncbi-amrfinderplus) | **AMRFinderPlus & database version** <details><summary> Click to see AMRFinderplus v3.12.8 and older versions! </summary> <ul><li>3.1.1b</li><li>3.8.4</li><li>3.8.28</li><li>3.9.3</li><li>3.9.8</li><li>3.10.1</li><li>3.10.5</li><li>3.10.16</li><li>3.10.20</li><li>3.10.24</li><li>3.10.30</li><li>3.10.36</li><li>3.10.42</li><li>3.11.2 & 2022-12-19.1</li><li>[3.11.2 & 2023-02-23.1](ncbi-amrfinderplus/3.11.2-2023-02-23.1/)</li><li>[3.11.4 & 2023-02-23.1](ncbi-amrfinderplus/3.11.4-2023-02-23.1/)</li></ul><ul><li>[3.11.8 & 2023-02-23.1](ncbi-amrfinderplus/3.11.8-2023-02-23.1/)</li><li>[3.11.11 & 2023-04-17.1](ncbi-amrfinderplus/3.11.11-2023-04-17.1)</li><li>[3.11.14 & 2023-04-17.1](ncbi-amrfinderplus/3.11.14-2023-04-17.1/)</li><li>[3.11.17 & 2023-07-13.2](ncbi-amrfinderplus/3.11.17-2023-07-13.2/)</li><li>[3.11.18 & 2023-08-08.2](ncbi-amrfinderplus/3.11.18-2023-08-08.2/)</li><li>[3.11.20 & 2023-09-26.1](ncbi-amrfinderplus/3.11.20-2023-09-26.1/)</li><li>[3.11.26 & 2023-11-15.1](ncbi-amrfinderplus/3.11.26-2023-11-15.1/)</li><li>[3.12.8 & 2024-01-31.1](ncbi-amrfinderplus/3.12.8-2024-01-31.1/)</li><li>[3.12.8 & 2024-05-02.2](./ncbi-amrfinderplus/3.12.8-2024-05-02.2/)</li><li>[3.12.8 & 2024-07-22.1](./ncbi-amrfinderplus/3.12.8-2024-07-22.1/)</li></details><li>[4.0.3 & 2024-10-22.1 (includes stxtyper)](./ncbi-amrfinderplus/4.0.3-2024-10-22.1/)</li><li>[4.0.3 & 2024-12-18.1 (includes stxtyper)](./ncbi-amrfinderplus/4.0.3-2024-12-18.1/)</li></ul> | [https://github.com/ncbi/amr](https://github.com/ncbi/amr) |
236236
| [NCBI table2asn](https://hub.docker.com/r/staphb/ncbi-table2asn) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/ncbi-table2asn)](https://hub.docker.com/r/staphb/ncbi-table2asn) | <ul><li>[1.26.678](./ncbi-table2asn/1.26.678/)</li><li>[1.28.943](./ncbi-table2asn/1.28.943/)</li><li>[1.28.1021](./ncbi-table2asn/1021/)</li></ul> | [https://www.ncbi.nlm.nih.gov/genbank/table2asn/](https://www.ncbi.nlm.nih.gov/genbank/table2asn/) <br/>[https://ftp.ncbi.nlm.nih.gov/asn1-converters/versions/2022-06-14/by_program/table2asn/](https://ftp.ncbi.nlm.nih.gov/asn1-converters/versions/2022-06-14/by_program/table2asn/) |
237237
| [ONTime](https://hub.docker.com/r/staphb/ontime) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/ontime)](https://hub.docker.com/r/staphb/ontime) | <ul><li>[0.2.3](ontime/0.2.3/)</li><li>[0.3.1](ontime/0.3.1/)</li></ul> | https://github.com/mbhall88/ontime |
238238
| [OrthoFinder](https://hub.docker.com/r/staphb/orthofinder) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/orthofinder)](https://hub.docker.com/r/staphb/orthofinder) | <ul><li>2.17</li></ul> | https://github.com/davidemms/OrthoFinder |
Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
FROM ubuntu:jammy AS app
2+
3+
ARG AMRFINDER_VER="4.0.3"
4+
ARG AMRFINDER_DB_VER="2024-12-18.1"
5+
ARG BLAST_VER="2.16.0"
6+
7+
LABEL base.image="ubuntu:jammy"
8+
LABEL dockerfile.version="1"
9+
LABEL software="NCBI AMRFinderPlus"
10+
LABEL software.version="${AMRFINDER_VER}"
11+
LABEL description="NCBI resistance gene detection tool"
12+
LABEL website="https://github.com/ncbi/amr"
13+
LABEL license="https://github.com/ncbi/amr/blob/master/LICENSE"
14+
LABEL maintainer="Kelsey Florek"
15+
LABEL maintainer.email="kelsey.florek@slh.wisc.edu"
16+
LABEL maintainer2="Curtis Kapsak"
17+
LABEL maintainer2.email="kapsakcj@gmail.com"
18+
LABEL maintainer3="Anders Goncalves da Silva"
19+
LABEL maintainer3.email="andersgs@gmail.com"
20+
LABEL maintainer4="Erin Young"
21+
LABEL maintainer4.email="eriny@utah.gov"
22+
LABEL maintainer5="Holly McQueary"
23+
LABEL maintainer5.email="holly.c.mcqueary@mass.gov"
24+
25+
# ncbi-blast+ installed via apt is v2.12.0 - DISABLING so that we can manually install a more recent version
26+
# see here for reason why I'm manualy installing 2.14.0 instead of using apt-get: https://github.com/ncbi/amr/releases/tag/amrfinder_v3.11.8
27+
28+
# hmmer installed via apt is v3.3.2
29+
# removed because likely unnecessary since we are not compiling from source: make g++
30+
# libgomp1 required for makeblastdb
31+
RUN apt-get update && apt-get install -y --no-install-recommends \
32+
ca-certificates \
33+
wget \
34+
curl \
35+
libgomp1 \
36+
hmmer \
37+
procps \
38+
gzip && \
39+
apt-get autoclean && \
40+
rm -rf /var/lib/apt/lists/*
41+
42+
# download and install amrfinderplus pre-compiled binaries; make /data
43+
RUN mkdir amrfinder && cd /amrfinder && \
44+
echo "downloading amrfinderplus v${AMRFINDER_VER} pre-compiled binaries from GitHub..." && \
45+
wget -q https://github.com/ncbi/amr/releases/download/amrfinder_v${AMRFINDER_VER}/amrfinder_binaries_v${AMRFINDER_VER}.tar.gz && \
46+
tar zxf amrfinder_binaries_v${AMRFINDER_VER}.tar.gz && \
47+
rm -v amrfinder_binaries_v${AMRFINDER_VER}.tar.gz && \
48+
mkdir -v /data
49+
50+
# install ncbi-blast linux binaries
51+
RUN echo "downloading ncbi-blast-${BLAST_VER}+ linux binaries from NCBI FTP..." && \
52+
wget -q https://ftp.ncbi.nlm.nih.gov/blast/executables/blast+/${BLAST_VER}/ncbi-blast-${BLAST_VER}+-x64-linux.tar.gz && \
53+
tar -xzf ncbi-blast-${BLAST_VER}+-x64-linux.tar.gz && \
54+
rm -v ncbi-blast-${BLAST_VER}+-x64-linux.tar.gz
55+
56+
# set PATH and locale settings for singularity compatibiliity, set amrfinder and manually-installed blast as higher priority in PATH
57+
ENV PATH="/amrfinder:/ncbi-blast-${BLAST_VER}+/bin:$PATH" \
58+
LC_ALL=C
59+
60+
# download databases and index them
61+
# done in this manner to pin the database version instead of pulling the latest version with `amrfinder -u`
62+
# softlink is required for `amrfinder -l` and typical `amrfinder` use cases to work properly
63+
RUN mkdir -p /amrfinder/data/${AMRFINDER_DB_VER} && \
64+
echo "Downloading amrfinder databases and indexing them now..." && \
65+
wget -q -P /amrfinder/data/${AMRFINDER_DB_VER} ftp://ftp.ncbi.nlm.nih.gov/pathogen/Antimicrobial_resistance/AMRFinderPlus/database/4.0/${AMRFINDER_DB_VER}/* && \
66+
amrfinder_index /amrfinder/data/${AMRFINDER_DB_VER} && \
67+
ln -s /amrfinder/data/${AMRFINDER_DB_VER} /amrfinder/data/latest
68+
69+
# set final working directory
70+
WORKDIR /data
71+
72+
# default command is to print help options
73+
CMD [ "amrfinder", "--help" ]
74+
75+
## Test stage
76+
FROM app AS test
77+
78+
# list database version and available --organism options
79+
RUN amrfinder -l
80+
81+
# run recommended tests from amrfinder; check that stx2a_operon is detected in outputs, meaning stxtyper ran correctly
82+
RUN cd /amrfinder && \
83+
bash test_amrfinder.sh . && \
84+
echo && echo "Checking for stx2a_operon string in test outputs..." && \
85+
grep 'stx2a_operon' test_both.got
86+
87+
# run amrfinder on Salmonella, without and with --organism option
88+
RUN echo "Downloading Salmonella genome (GCA_010941835.1_PDT000052640.3) for testing now..." && \
89+
wget -q https://ftp.ncbi.nlm.nih.gov/genomes/all/GCA/010/941/835/GCA_010941835.1_PDT000052640.3/GCA_010941835.1_PDT000052640.3_genomic.fna.gz && \
90+
amrfinder --threads 4 --plus --nucleotide GCA_010941835.1_PDT000052640.3_genomic.fna.gz --output test1.txt && \
91+
amrfinder --threads 4 --plus --nucleotide GCA_010941835.1_PDT000052640.3_genomic.fna.gz --organism Salmonella --output test2.txt && \
92+
head test1.txt test2.txt
93+
94+
# run amrfinder on Klebesiella oxytoca using --organism/-O flag
95+
RUN echo "Downloading Klebsiella oxytoca genome (GCA_003812925.1_ASM381292v1) for testing now..." && \
96+
wget -q https://ftp.ncbi.nlm.nih.gov/genomes/all/GCA/003/812/925/GCA_003812925.1_ASM381292v1/GCA_003812925.1_ASM381292v1_genomic.fna.gz && \
97+
amrfinder --threads 4 --plus --name GCA_003812925.1 -n GCA_003812925.1_ASM381292v1_genomic.fna.gz -O Klebsiella_oxytoca -o GCA_003812925.1-amrfinder.tsv && \
98+
head GCA_003812925.1-amrfinder.tsv
99+
100+
# test that gunzip is installed
101+
RUN gunzip --help
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# NCBI AMRFinderPlus docker image
2+
3+
Main tool : [NCBI AMRFinderPlus](https://github.com/ncbi/amr)
4+
5+
Additional tools:
6+
7+
- hmmer v3.3.2
8+
- ncbi-blast+ v2.16.0
9+
- [stxtyper](https://github.com/ncbi/stxtyper/) v1.0.27 (Shiga toxin subtyping tool, added in AMRFinderPlus v4.0.3)
10+
11+
## Database information
12+
13+
The database included at time of docker image build is **`2024-12-18.1`**. More information can be found in the [changelog.txt on NCBI's FTP](https://ftp.ncbi.nlm.nih.gov/pathogen/Antimicrobial_resistance/AMRFinderPlus/database/4.0/2024-12-18.1/changes.txt).
14+
15+
Full documentation: [https://github.com/ncbi/amr/wiki](https://github.com/ncbi/amr/wiki)
16+
17+
## Docker Image Tags
18+
19+
Beginning with AMRFinderPlus v3.11.2, we will include the version of AMRFinderPlus followed by the database version in the docker image tag so that it is more informative to users. The format is as follows:
20+
21+
```bash
22+
# general format
23+
staphb/ncbi-amrfinderplus:<amrfinderplus-version>-<database-version>
24+
25+
# example
26+
staphb/ncbi-amrfinderplus:3.11.14-2023-04-17.1
27+
```
28+
29+
You can view all available docker images on [dockerhub](https://hub.docker.com/r/staphb/ncbi-amrfinderplus/tags) and [quay.io](https://quay.io/repository/staphb/ncbi-amrfinderplus?tab=tags)
30+
31+
## Example Usage
32+
33+
```bash
34+
# list out the available organisms for the -O/--organism flag
35+
$ amrfinder -l
36+
Running: amrfinder -l
37+
Software directory: '/amrfinder/'
38+
Software version: 3.12.8
39+
Database directory: '/amrfinder/data/2024-01-31.1'
40+
Database version: 2024-01-31.1
41+
42+
Available --organism options: Acinetobacter_baumannii, Burkholderia_cepacia, Burkholderia_pseudomallei, Campylobacter,
43+
Citrobacter_freundii, Clostridioides_difficile, Enterobacter_asburiae, Enterobacter_cloacae, Enterococcus_faecalis,
44+
Enterococcus_faecium, Escherichia, Klebsiella_oxytoca, Klebsiella_pneumoniae, Neisseria_gonorrhoeae,
45+
Neisseria_meningitidis, Pseudomonas_aeruginosa, Salmonella, Serratia_marcescens, Staphylococcus_aureus,
46+
Staphylococcus_pseudintermedius, Streptococcus_agalactiae, Streptococcus_pneumoniae, Streptococcus_pyogenes,
47+
Vibrio_cholerae, Vibrio_parahaemolyticus, Vibrio_vulnificus
48+
49+
# download Klebsiella oxytoca genome FASTA/FNA to use as a test
50+
$ wget "https://ftp.ncbi.nlm.nih.gov/genomes/all/GCA/003/812/925/GCA_003812925.1_ASM381292v1/GCA_003812925.1_ASM381292v1_genomic.fna.gz"
51+
52+
# uncompress the FNA file
53+
$ gzip -d GCA_003812925.1_ASM381292v1_genomic.fna.gz
54+
55+
# run amrfinder (nucleotide mode) on the uncompressed FNA file
56+
$ amrfinder --plus --name GCA_003812925.1 -n GCA_003812925.1_ASM381292v1_genomic.fna -O Klebsiella_oxytoca -o GCA_003812925.1-amrfinder.tsv
57+
58+
# view output TSV
59+
$ column -t -s $'\t' -n GCA_003812925.1-amrfinder.tsv
60+
Name Protein identifier Contig id Start Stop Strand Gene symbol Sequence name Scope Element type Element subtype Class Subclass Method Target length Reference sequence length % Coverage of reference sequence % Identity to reference sequence Alignment length Accession of closest sequence Name of closest sequence HMM id HMM description
61+
GCA_003812925.1 NA CP033844.1 369234 370406 + oqxA multidrug efflux RND transporter periplasmic adaptor subunit OqxA core AMR AMR PHENICOL/QUINOLONE PHENICOL/QUINOLONE BLASTX 391 391 100.00 90.79 391 WP_002914189.1 multidrug efflux RND transporter periplasmic adaptor subunit OqxA NA NA
62+
GCA_003812925.1 NA CP033844.1 370433 373582 + oqxB multidrug efflux RND transporter permease subunit OqxB core AMR AMR PHENICOL/QUINOLONE PHENICOL/QUINOLONE BLASTX 1050 1050 100.00 96.86 1050 WP_023323140.1 multidrug efflux RND transporter permease subunit OqxB15 NA NA
63+
GCA_003812925.1 NA CP033844.1 636118 637917 - ybtQ yersiniabactin ABC transporter ATP-binding/permease protein YbtQ plus VIRULENCE VIRULENCE NA NA BLASTX 600 600 100.00 89.17 600 AAC69584.1 yersiniabactin ABC transporter ATP-binding/permease protein YbtQ NA NA
64+
GCA_003812925.1 NA CP033844.1 637913 639706 - ybtP yersiniabactin ABC transporter ATP-binding/permease protein YbtP plus VIRULENCE VIRULENCE NA NA BLASTX 598 600 99.67 89.30 598 CAA21388.1 yersiniabactin ABC transporter ATP-binding/permease protein YbtP NA NA
65+
GCA_003812925.1 NA CP033844.1 3473617 3474798 + emrD multidrug efflux MFS transporter EmrD plus AMR AMR EFFLUX EFFLUX BLASTX 394 394 100.00 94.16 394 ACN65732.1 multidrug efflux MFS transporter EmrD NA NA
66+
GCA_003812925.1 NA CP033844.1 5085488 5086357 - blaOXY-2-1 extended-spectrum class A beta-lactamase OXY-2-1 core AMR AMR BETA-LACTAM CEPHALOSPORIN ALLELEX 290 290 100.00 100.00 290 WP_032727905.1 extended-spectrum class A beta-lactamase OXY-2-1 NA NA
67+
GCA_003812925.1 NA CP033845.1 5102 5632 - ant(2'')-Ia aminoglycoside nucleotidyltransferase ANT(2'')-Ia core AMR AMR AMINOGLYCOSIDE GENTAMICIN/KANAMYCIN/TOBRAMYCIN BLASTX 177 177 100.00 98.31 177 WP_000381803.1 aminoglycoside nucleotidyltransferase ANT(2'')-Ia NA NA
68+
GCA_003812925.1 NA CP033846.1 748 1932 - tet(39) tetracycline efflux MFS transporter Tet(39) core AMR AMR TETRACYCLINE TETRACYCLINE EXACTX 395 395 100.00 100.00 395 WP_004856455.1 tetracycline efflux MFS transporter Tet(39)
69+
```

0 commit comments

Comments
 (0)