Skip to content

Commit 4fdd2b7

Browse files
authored
Merge pull request #1589 from Kincekara/plasmidfinder
add plasmidfinder 3.0.3
2 parents 3ca2955 + b28a276 commit 4fdd2b7

File tree

3 files changed

+86
-1
lines changed

3 files changed

+86
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ To learn more about the docker pull rate limits and the open source software pro
267267
| [Piggy](https://hub.docker.com/r/staphb/piggy) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/piggy)](https://hub.docker.com/r/staphb/piggy) | <details><summary>Click to see all versions</summary> <ul><li>[1.5](./build-files/piggy/1.5/)</li></ul> </details> | https://github.com/harry-thorpe/piggy |
268268
| [Pilon](https://hub.docker.com/r/staphb/pilon) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/pilon)](https://hub.docker.com/r/staphb/pilon) | <details><summary>Click to see all versions</summary> <ul><li>[1.23.0](./build-files/pilon/1.23.0/)</li><li>[1.24](./build-files/pilon/1.24/)</li></ul> </details> | https://github.com/broadinstitute/pilon |
269269
| [Piranha](https://hub.docker.com/r/staphb/piranha) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/piranha)](https://hub.docker.com/r/staphb/piranha) | <details><summary>Click to see all versions</summary> <ul><li>[1.0.4](./build-files/piranha/1.0.4/)</li><li>[1.4.2](./build-files/piranha/1.4.2/)</li><li>[1.5.3](./build-files/piranha/1.5.3/)</li></ul> </details> | https://github.com/polio-nanopore/piranha |
270-
| [PlasmidFinder](https://hub.docker.com/r/staphb/plasmidfinder) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/plasmidfinder)](https://hub.docker.com/r/staphb/plasmidfinder) | <details><summary>Click to see all versions</summary> <ul><li>[2.1.6](./build-files/plasmidfinder/2.1.6/)</li><li>[2.1.6_2024-03-07](./build-files/plasmidfinder/2.1.6_2024-03-07/)</li><li>[2.1.6_2025-02-19](./build-files/plasmidfinder/2.1.6_2025-02-19/)</li><li>[3.0.1](./build-files/plasmidfinder/3.0.1/)</li><li>[3.0.2](./build-files/plasmidfinder/3.0.2/)</li></ul> </details> | https://bitbucket.org/genomicepidemiology/plasmidfinder/src/master/ |
270+
| [PlasmidFinder](https://hub.docker.com/r/staphb/plasmidfinder) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/plasmidfinder)](https://hub.docker.com/r/staphb/plasmidfinder) | <details><summary>Click to see all versions</summary> <ul><li>[2.1.6](./build-files/plasmidfinder/2.1.6/)</li><li>[2.1.6_2024-03-07](./build-files/plasmidfinder/2.1.6_2024-03-07/)</li><li>[2.1.6_2025-02-19](./build-files/plasmidfinder/2.1.6_2025-02-19/)</li><li>[3.0.1](./build-files/plasmidfinder/3.0.1/)</li><li>[3.0.2](./build-files/plasmidfinder/3.0.2/)</li><li>[3.0.3](./build-files/plasmidfinder/3.0.3)</li></ul> </details> | https://bitbucket.org/genomicepidemiology/plasmidfinder/src/master/ |
271271
| [PlasmidSeeker](https://hub.docker.com/r/staphb/plasmidseeker) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/plasmidseeker)](https://hub.docker.com/r/staphb/plasmidseeker) | <details><summary>Click to see all versions</summary> <ul><li>[1.0](./build-files/plasmidseeker/1.0/)</li><li>[1.3](./build-files/plasmidseeker/1.3/)</li></ul> </details> | https://github.com/bioinfo-ut/PlasmidSeeker |
272272
| [plassembler](https://hub.docker.com/r/staphb/plassembler/) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/plassembler)](https://hub.docker.com/r/staphb/plassembler) | <details><summary>Click to see all versions</summary> <ul><li>[1.6.2](./build-files/plassembler/1.6.2/)</li><li>[1.8.0](./build-files/plassembler/1.8.0/)</li><li>[1.8.1](./build-files/plassembler/1.8.1/)</li><li>[1.8.2](./build-files/plassembler/1.8.2/)</li></ul> </details> | https://github.com/gbouras13/plassembler |
273273
| [pling](https://hub.docker.com/r/staphb/pling/) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/pling)](https://hub.docker.com/r/staphb/pling) | <details><summary>Click to see all versions</summary> <ul><li>[2.0.0](./build-files/pling/2.0.0)</li><li>[2.0.1](./build-files/pling/2.0.1)</li></ul> </details> | https://github.com/iqbal-lab-org/pling |
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
FROM staphb/kma:1.6.4 AS kma
2+
3+
FROM ubuntu:noble AS app
4+
5+
# set env to avoid /.gitconfig permission error on AWS
6+
ENV HOME=/root
7+
8+
ARG PLASMIDFINDER_VER="3.0.3"
9+
10+
LABEL base.image="ubuntu:noble"
11+
LABEL dockerfile.version="1"
12+
LABEL software="plasmidfinder"
13+
LABEL software.version="${PLASMIDFINDER_VER}"
14+
LABEL description="Identifies plasmids in total or partial sequenced isolates of bacteria."
15+
LABEL website="https://bitbucket.org/genomicepidemiology/plasmidfinder"
16+
LABEL license="https://bitbucket.org/genomicepidemiology/plasmidfinder/src/master/README.md"
17+
LABEL maintainer="Kutluhan Incekara"
18+
LABEL maintainer.email="kutluinct@gmail.com"
19+
LABEL maintainer2="Erin Young"
20+
LABEL maintainer2.email="eriny@utah.gov"
21+
22+
# install dependencies; cleanup apt garbage
23+
# ncbi-blast+ v2.12.0 (ubuntu:jammy), min required version is 2.8.1
24+
# python3 v3.10.12, min required version is 3.10
25+
RUN apt-get update && apt-get install -y --no-install-recommends \
26+
wget \
27+
ca-certificates \
28+
procps \
29+
ncbi-blast+ \
30+
python3-pip \
31+
git \
32+
python-is-python3 && \
33+
apt-get autoclean && rm -rf /var/lib/apt/lists/* && \
34+
update-alternatives --install /usr/bin/python python /usr/bin/python3 10
35+
36+
COPY --from=kma /usr/local/bin/* /usr/local/bin/
37+
38+
# download plasmindfinder database
39+
RUN git clone -b plasmidfinder-${PLASMIDFINDER_VER} --depth 1 https://bitbucket.org/genomicepidemiology/plasmidfinder_db.git &&\
40+
cd plasmidfinder_db &&\
41+
python INSTALL.py &&\
42+
rm -rf .git
43+
44+
# install plasmidfinder to specific tag/version; make /data
45+
RUN pip3 install --no-cache-dir --break-system-packages PlasmidFinder==${PLASMIDFINDER_VER} && \
46+
mkdir /data
47+
48+
# set $PATH and locale settings for singularity compatibility
49+
ENV PATH="${PATH}" \
50+
LC_ALL=C.UTF-8 \
51+
CGE_BLASTN=/usr/bin/blastn \
52+
CGE_PLASMIDFINDER_DB=/plasmidfinder_db \
53+
PLASMID_DB=/plasmidfinder_db
54+
55+
# set final working directory for production docker image (app layer only)
56+
WORKDIR /data
57+
58+
# default command is to pull up help options for virulencefinder
59+
CMD ["python", "-m", "plasmidfinder", "-h"]
60+
61+
### START OF TEST STAGE ###
62+
FROM app AS test
63+
64+
RUN python -m plasmidfinder -h
65+
66+
RUN wget ftp://ftp.sra.ebi.ac.uk/vol1/fastq/ERR193/000/ERR1937840/ERR1937840.fastq.gz && \
67+
gzip -d ERR1937840.fastq.gz && mkdir test && \
68+
python -m plasmidfinder -i ERR1937840.fastq -o test
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Plasmidfinder Container
2+
3+
Main tool: [Plasmidfinder](https://bitbucket.org/genomicepidemiology/plasmidfinder/src/master/)
4+
5+
Additional tools:
6+
- kma : 1.6.4
7+
- blast : 2.12.0
8+
- plasmidfinder_db : plasmidfinder-3.0.3 (2.2.0)
9+
10+
The PlasmidFinder service contains one python script plasmidfinder.py which is the script of the latest version of the PlasmidFinder service. The service identifies plasmids in total or partial sequenced isolates of bacteria.
11+
12+
# Example Usage
13+
```{bash}
14+
python -m plasmidfinder -i ERR1937840.fastq -o test
15+
```
16+
17+
Better documentation can be found at [Plasmidfinder](https://bitbucket.org/genomicepidemiology/plasmidfinder/src/master/)

0 commit comments

Comments
 (0)