Skip to content

Commit 62bdad6

Browse files
authored
Merge pull request #1719 from RaheelSyedAhmed/spestimator-0.3.0.235
Spestimator version 0.3.0.235
2 parents 6892891 + 7092f72 commit 62bdad6

3 files changed

Lines changed: 82 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@ To learn more about the docker pull rate limits and the open source software pro
332332
| [SNP-sites](https://hub.docker.com/r/staphb/snp-sites) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/snp-sites)](https://hub.docker.com/r/staphb/snp-sites) | <details><summary>Click to see all versions</summary> <ul><li>[2.3.3](./build-files/snp-sites/2.3.3/)</li><li>[2.5.1](./build-files/snp-sites/2.5.1/)</li><li>[2.5.1-2601](./build-files/snp-sites/2.5.1-2601/)</li></ul> </details> | https://github.com/sanger-pathogens/snp-sites |
333333
| [SNVPhyl-tools](https://hub.docker.com/r/staphb/snvphyl-tools) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/snvphyl-tools)](https://hub.docker.com/r/staphb/snvphyl-tools) | <details><summary>Click to see all versions</summary> <ul><li>[1.8.2](./build-files/snvphyl-tools/1.8.2/)</li></ul> </details> | https://github.com/phac-nml/snvphyl-tools |
334334
| [SPAdes](https://hub.docker.com/r/staphb/spades/) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/spades)](https://hub.docker.com/r/staphb/spades) | <details><summary>Click to see all versions</summary> <ul><li>[3.8.2](./build-files/spades/3.8.2/)</li><li>[3.12.0](./build-files/spades/3.12.0/)</li><li>[3.13.0](./build-files/spades/3.13.0/)</li><li>[3.14.0](./build-files/spades/3.14.0/)</li><li>[3.14.1](./build-files/spades/3.14.1/)</li><li>[3.15.0](./build-files/spades/3.15.0/)</li><li>[3.15.1](./build-files/spades/3.15.1/)</li><li>[3.15.2](./build-files/spades/3.15.2/)</li><li>[3.15.3](./build-files/spades/3.15.3/)</li><li>[3.15.4](./build-files/spades/3.15.4/)</li><li>[3.15.5](./build-files/spades/3.15.5/)</li><li>[4.0.0](./build-files/spades/4.0.0/)</li><li>[4.1.0](./build-files/spades/4.1.0/)</li><li>[4.2.0](./build-files/spades/4.2.0/)</li></ul></details> | https://github.com/ablab/spades </br> http://cab.spbu.ru/software/spades/ |
335-
| [Spestimator](https://hub.docker.com/r/staphb/spestimator/) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/spestimator)](https://hub.docker.com/r/staphb/spestimator) | <details><summary>Click to see all versions</summary> <ul><li>[0.1.0.232](./build-files/spestimator/0.1.0.232/)</li><li>[0.3.0.233](./build-files/spestimator/0.3.0.233/)</li><li>[0.3.0.234](./build-files/spestimator/0.3.0.234/)</li></ul> </details> | https://github.com/erinyoung/Spestimator |
335+
| [Spestimator](https://hub.docker.com/r/staphb/spestimator/) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/spestimator)](https://hub.docker.com/r/staphb/spestimator) | <details><summary>Click to see all versions</summary> <ul><li>[0.1.0.232](./build-files/spestimator/0.1.0.232/)</li><li>[0.3.0.233](./build-files/spestimator/0.3.0.233/)</li><li>[0.3.0.234](./build-files/spestimator/0.3.0.234/)</li><li>[0.3.0.235](./build-files/spestimator/0.3.0.235/)</li></ul> </details> | https://github.com/erinyoung/Spestimator |
336336
| [SRA-toolkit](https://hub.docker.com/r/staphb/sratoolkit/) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/sratoolkit)](https://hub.docker.com/r/staphb/sratoolkit) | <details><summary>Click to see all versions</summary> <ul><li>[2.9.2](./build-files/sratoolkit/2.9.2/)</li><li>[3.0.7](./build-files/sratoolkit/3.0.7/)</li><li>[3.2.0](./build-files/sratoolkit/3.2.0/)</li><li>[3.2.1](./build-files/sratoolkit/3.2.1/)</li><li>[3.3.0](./build-files/sratoolkit/3.3.0/)</li><li>[3.4.1](./build-files/sratoolkit/3.4.1/)</li></ul> </details> | https://github.com/ncbi/sra-tools |
337337
| [SRST2](https://hub.docker.com/r/staphb/srst2/) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/srst2)](https://hub.docker.com/r/staphb/srst2) | <details><summary>Click to see all versions</summary> <ul><li>[0.2.0](./build-files/srst2/0.2.0/)</li><li>[0.2.0 + custom Vibrio cholerae database](./build-files/srst2/0.2.0-vibrio-230224/README.md)</li></ul> </details> | https://github.com/katholt/srst2 |
338338
| [StaphSCAN](https://hub.docker.com/r/staphb/staphscan/) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/staphscan)](https://hub.docker.com/r/staphb/staphscan) | <details><summary>Click to see all versions</summary> <ul><li>[0.3.1](./build-files/staphscan/0.3.1/)</li></ul> </details> | https://github.com/riccabolla/StaphSCAN |
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
FROM ubuntu:noble AS app
2+
3+
ARG SPESTIMATOR_VER="0.3.0.235"
4+
5+
LABEL base.image="ubuntu:noble"
6+
LABEL dockerfile.version="1"
7+
LABEL software="Spestimator"
8+
LABEL software.version="${SPESTIMATOR_VER}"
9+
LABEL description="Uses 16S to identify a range of possible species."
10+
LABEL website="https://github.com/erinyoung/Spestimator"
11+
LABEL license="https://github.com/erinyoung/Spestimator/blob/main/LICENSE"
12+
LABEL maintainer="Erin Young"
13+
LABEL maintainer.email="eriny@utah.gov"
14+
15+
# 'RUN' executes code during the build
16+
# Install dependencies via apt-get or yum if using a centos or fedora base
17+
RUN apt-get update && apt-get install -y --no-install-recommends \
18+
ncbi-blast+ \
19+
python3-pip && \
20+
apt-get autoclean && rm -rf /var/lib/apt/lists/*
21+
22+
RUN pip install --no-cache-dir --break-system-packages spestimator==${SPESTIMATOR_VER} && \
23+
spestimator -h && \
24+
mkdir /data
25+
26+
ENV LC_ALL=C
27+
28+
# 'CMD' instructions set a default command when the container is run. This is typically 'tool --help.'
29+
CMD [ "spestimator", "-h" ]
30+
31+
# 'WORKDIR' sets working directory
32+
WORKDIR /data
33+
34+
##### ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- #####
35+
##### Step 2. Set up the testing stage. #####
36+
##### The docker image is built to the 'test' stage before merging, but #####
37+
##### the test stage (or any stage after 'app') will be lost. #####
38+
##### ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- #####
39+
40+
# A second FROM insruction creates a new stage
41+
FROM app AS test
42+
43+
# set working directory so that all test inputs & outputs are kept in /test
44+
WORKDIR /test
45+
46+
RUN spestimator --help && \
47+
spestimator --version
48+
49+
RUN apt-get update && apt-get install -y wget
50+
51+
RUN wget https://ftp.ncbi.nlm.nih.gov/genomes/all/GCF/900/636/985/GCF_900636985.1_45889_C01/GCF_900636985.1_45889_C01_genomic.fna.gz && \
52+
gunzip GCF_900636985.1_45889_C01_genomic.fna.gz && \
53+
spestimator -i *.fna -o testing.csv --download-genomes genomes && \
54+
head testing.csv && \
55+
ls genomes/* | wc -l
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Spestimator container
2+
3+
Main tool: [spestimator](https://github.com/erinyoung/Spestimator)
4+
5+
Code repository: https://github.com/erinyoung/Spestimator
6+
7+
Additional tools:
8+
- list: blast+ v2.12.0
9+
10+
Basic information on how to use this tool:
11+
- executable: spestimator
12+
- help: -h
13+
- version: -v
14+
- description: |
15+
16+
> Spestimator is a lightweight Python command-line tool designed to quickly identify bacterial species from input FASTA sequences (contigs or reads) and automatically retrieve their corresponding reference genomes from NCBI RefSeq.
17+
18+
19+
Full documentation: https://github.com/erinyoung/Spestimator
20+
21+
## Example Usage
22+
23+
```bash
24+
spestimator -i *.fna -o testing.csv --download-genomes genomes
25+
```
26+

0 commit comments

Comments
 (0)