-
Notifications
You must be signed in to change notification settings - Fork 126
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #900 from Kincekara/kma
update kma
- Loading branch information
Showing
3 changed files
with
87 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
ARG KMA_VER="1.4.14" | ||
|
||
## Builder ## | ||
FROM ubuntu:jammy as builder | ||
|
||
ARG KMA_VER | ||
|
||
RUN apt-get update && apt-get install -y --no-install-recommends \ | ||
gcc \ | ||
libz-dev \ | ||
make \ | ||
ca-certificates \ | ||
git && \ | ||
rm -rf /var/lib/apt/lists/* && apt-get autoclean | ||
|
||
RUN git clone -b ${KMA_VER} --single-branch https://bitbucket.org/genomicepidemiology/kma.git &&\ | ||
cd kma &&\ | ||
make &&\ | ||
mv kma kma_index kma_shm kma_update /usr/local/bin/ | ||
|
||
## App ## | ||
FROM ubuntu:jammy as app | ||
|
||
ARG KMA_VER | ||
|
||
LABEL base.image="ubuntu:jammy" | ||
LABEL dockerfile.version="1" | ||
LABEL software="kma" | ||
LABEL software.version="$KMA_VER" | ||
LABEL description="K-mer alignment of raw reads against a database" | ||
LABEL website="https://bitbucket.org/genomicepidemiology/kma/src/master/" | ||
LABEL license="https://bitbucket.org/genomicepidemiology/kma/src/master/" | ||
LABEL license.type="Apache License, V2.0" | ||
LABEL maintainer="Curtis Kapsak" | ||
LABEL maintainer.email="[email protected]" | ||
LABEL maintainer2="Kutluhan Incekara" | ||
LABEL maintainer2.email="[email protected]" | ||
|
||
COPY --from=builder /usr/local/bin/* /usr/local/bin/ | ||
|
||
ENV LC_ALL=C | ||
|
||
CMD ["kma", "-h"] | ||
|
||
WORKDIR /data | ||
|
||
## Test ## | ||
FROM app as test | ||
|
||
RUN apt-get update && apt-get install -y --no-install-recommends wget | ||
|
||
# Downloads E.coli genome and runs kma index on it | ||
RUN wget -q --no-check-certificate https://ftp.ncbi.nlm.nih.gov/genomes/all/GCA/012/224/845/GCA_012224845.2_ASM1222484v2/GCA_012224845.2_ASM1222484v2_genomic.fna.gz && \ | ||
gunzip GCA_012224845.2_ASM1222484v2_genomic.fna.gz && \ | ||
kma index -i GCA_012224845.2_ASM1222484v2_genomic.fna -o database | ||
|
||
# Downloads read files and uses them for kma mapping against database; print kma version | ||
RUN wget -q --no-check-certificate ftp://ftp.sra.ebi.ac.uk/vol1/fastq/SRR690/006/SRR6903006/SRR6903006_1.fastq.gz && \ | ||
wget -q --no-check-certificate ftp://ftp.sra.ebi.ac.uk/vol1/fastq/SRR690/006/SRR6903006/SRR6903006_2.fastq.gz && \ | ||
kma -ipe SRR6903006_1.fastq.gz SRR6903006_2.fastq.gz -o test_output -t_db database -tmp /tmp/ && \ | ||
kma -v |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# kma container | ||
|
||
Main tool : [kma](https://bitbucket.org/genomicepidemiology/kma/) | ||
|
||
Code repository: https://bitbucket.org/genomicepidemiology/kma/src/master/ | ||
|
||
Basic information on how to use this tool: | ||
- executable: kma | ||
- help: -h | ||
- version: -v | ||
- description: k-mer mapping of raw reads to a redundant database | ||
|
||
Full documentation: https://bitbucket.org/genomicepidemiology/kma/src/master/ | ||
|
||
## Example Usage | ||
|
||
```bash | ||
# Database needs to be indexed to use kma for mapping: | ||
kma index -i templates.fsa.gz -o database/name | ||
|
||
# kma mapping of paired and unpaired read files: | ||
kma -ipe SRR13957123_*.fastq.gz -o test.output -t_db DB_name | ||
|
||
kma -i singleEndReads.fq.gz -ipe pairedEnd_*.fq.gz -o output/name -t_db database/name -1t1` | ||
``` |