Skip to content

Commit 0d02776

Browse files
authored
adding skani version 0.3.1 (#1471)
1 parent 80f290e commit 0d02776

File tree

3 files changed

+81
-1
lines changed

3 files changed

+81
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ To learn more about the docker pull rate limits and the open source software pro
312312
| [SISTR](https://hub.docker.com/r/staphb/sistr/) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/sistr)](https://hub.docker.com/r/staphb/sistr) | <details><summary>Click to see all versions</summary> <ul><li>[1.0.2](./build-files/sistr/1.0.2/)</li><li>[1.1.1](./build-files/sistr/1.1.1/)</li><li>[1.1.2](./build-files/sistr/1.1.2/)</li><li>[1.1.3](./build-files/sistr/1.1.3/)</li></ul> </details> | https://github.com/phac-nml/sistr_cmd |
313313
| [SKA](https://hub.docker.com/r/staphb/ska/) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/ska)](https://hub.docker.com/r/staphb/ska) | <details><summary>Click to see all versions</summary> <ul><li>[1.0](./build-files/ska/1.0/)</li></ul> </details> | https://github.com/simonrharris/SKA |
314314
| [SKA2](https://hub.docker.com/r/staphb/ska2/) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/ska2)](https://hub.docker.com/r/staphb/ska2) | <details><summary>Click to see all versions</summary> <ul><li>[0.3.6](./build-files/ska2/0.3.6/)</li><li>[0.3.7](./build-files/ska2/0.3.7/)</li><li>[0.3.10](./build-files/ska2/0.3.10/)</li><li>[0.4.0](./build-files/ska2/0.4.0/)</li><li>[0.4.1](./build-files/ska2/0.4.1/)</li></ul> </details> | https://github.com/bacpop/ska.rust |
315-
| [skani](https://github.com/bluenote-1577/skani) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/skani)](https://hub.docker.com/r/staphb/skani) | <details><summary>Click to see all versions</summary> <ul><li>[0.2.0](./build-files/skani/0.2.0)</li><li>[0.2.1](./build-files/skani/0.2.1)</li><li>[0.2.2](./build-files/skani/0.2.2)</li><li>[0.3.0](./build-files/skani/0.3.0)</li></ul> </details> | https://github.com/bluenote-1577/skani |
315+
| [skani](https://github.com/bluenote-1577/skani) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/skani)](https://hub.docker.com/r/staphb/skani) | <details><summary>Click to see all versions</summary> <ul><li>[0.2.0](./build-files/skani/0.2.0)</li><li>[0.2.1](./build-files/skani/0.2.1)</li><li>[0.2.2](./build-files/skani/0.2.2)</li><li>[0.3.0](./build-files/skani/0.3.0)</li><li>[0.3.1](./build-files/skani/0.3.1)</li></ul> </details> | https://github.com/bluenote-1577/skani |
316316
| [SKESA](https://hub.docker.com/r/staphb/skesa) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/skesa)](https://hub.docker.com/r/staphb/skesa) | <details><summary>Click to see all versions</summary> <ul><li>[2.3.0](./build-files/skesa/2.3.0/)</li><li>[2.4.0 (`gfa_connector` & `kmercounter` included)](./build-files/skesa/2.4.0/)</li><li>[skesa.2.4.0_saute.1.3.0_2 (also known as 2.5.1)](./build-files/skesa/skesa.2.4.0_saute.1.3.0_2/)</li></ul> </details> | https://github.com/ncbi/SKESA |
317317
| [Smalt](https://hub.docker.com/r/staphb/smalt) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/smalt)](https://hub.docker.com/r/staphb/smalt) | <details><summary>Click to see all versions</summary> <ul><li>[0.7.6](./build-files/smalt/0.7.6/)</li></ul> </details> | https://www.sanger.ac.uk/tool/smalt-0/ |
318318
| [snpeff](https://hub.docker.com/r/staphb/snpeff) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/snpeff)](https://hub.docker.com/r/staphb/snpeff) | <details><summary>Click to see all versions</summary> <ul><li>[5.1](./build-files/snpeff/5.1/)</li><li>[5.2a](./build-files/snpeff/5.2a/)</li><li>[5.2f](./build-files/snpeff/5.2f/)</li></ul> </details> | https://pcingola.github.io/SnpEff |

build-files/skani/0.3.1/Dockerfile

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
ARG SKANI_VER="0.3.1"
2+
3+
## Builder ##
4+
FROM rust:1.90.0 AS builder
5+
6+
ARG SKANI_VER
7+
8+
RUN wget https://github.com/bluenote-1577/skani/archive/refs/tags/v${SKANI_VER}.tar.gz &&\
9+
tar -xvf v${SKANI_VER}.tar.gz &&\
10+
cd skani-${SKANI_VER} &&\
11+
cargo install --path . --root ~/.cargo &&\
12+
chmod +x /root/.cargo/bin/skani
13+
14+
## App ##
15+
FROM ubuntu:jammy AS app
16+
17+
ARG SKANI_VER
18+
19+
LABEL base.image="ubuntu:jammy"
20+
LABEL dockerfile.version="1"
21+
LABEL software="skani"
22+
LABEL software.version=${SKANI_VER}
23+
LABEL description="skani is a program for calculating average nucleotide identity (ANI) from DNA sequences (contigs/MAGs/genomes) for ANI > ~80%."
24+
LABEL website="https://github.com/bluenote-1577/skani"
25+
LABEL license="https://github.com/bluenote-1577/skani/blob/main/LICENSE"
26+
LABEL maintainer="Kutluhan Incekara"
27+
LABEL maintainer.email="kutluhan.incekara@ct.gov"
28+
29+
# copy app from builder stage
30+
COPY --from=builder /root/.cargo/bin/skani /usr/local/bin/skani
31+
32+
# default run command
33+
CMD ["skani", "-h"]
34+
35+
# singularity compatibility
36+
ENV LC_ALL=C
37+
38+
WORKDIR /data
39+
40+
## Test ##
41+
FROM app AS test
42+
43+
RUN apt-get update && apt-get install -y wget &&\
44+
wget https://github.com/bluenote-1577/skani/raw/v0.2.0/refs/e.coli-EC590.fasta &&\
45+
wget https://github.com/bluenote-1577/skani/raw/v0.2.0/refs/e.coli-K12.fasta
46+
47+
RUN skani dist e.coli-EC590.fasta e.coli-K12.fasta

build-files/skani/0.3.1/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# skani container
2+
3+
Main tool: [skani](https://github.com/bluenote-1577/skani)
4+
5+
Code repository: https://github.com/bluenote-1577/skani
6+
7+
Basic information on how to use this tool:
8+
- executable: skani
9+
- help: -h, --help
10+
- version: -V, --version
11+
- description: skani is a program for calculating average nucleotide identity (ANI) from DNA sequences (contigs/MAGs/genomes) for ANI > ~80%.
12+
13+
Additional information:
14+
15+
This container does not contain any database or reference genome.
16+
17+
Full documentation: https://github.com/bluenote-1577/skani/wiki
18+
19+
## Example Usage
20+
21+
Quick ANI calculation:
22+
```bash
23+
skani dist genome1.fa genome2.fa
24+
```
25+
Memory-efficient database search:
26+
```bash
27+
skani sketch genomes/* -o database
28+
skani search -d database query1.fa query2.fa ...
29+
```
30+
All-to-all comparison:
31+
```bash
32+
skani triangle genomes/*
33+
```

0 commit comments

Comments
 (0)