-
Notifications
You must be signed in to change notification settings - Fork 119
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 #893 from Kincekara/ska2
adds ska2
- Loading branch information
Showing
4 changed files
with
72 additions
and
0 deletions.
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
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,46 @@ | ||
FROM ubuntu:jammy as app | ||
|
||
ARG SKA2_VER="0.3.6" | ||
|
||
LABEL base.image="ubuntu:jammy" | ||
LABEL dockerfile.version="1" | ||
LABEL software="SKA2" | ||
LABEL software.version="${SKA2_VER}" | ||
LABEL description="A reimplementation of the SKA package in the rust language" | ||
LABEL website="https://github.com/bacpop/ska.rust" | ||
LABEL license="https://github.com/bacpop/ska.rust/blob/master/LICENSE" | ||
LABEL maintainer="Kutluhan Incekara" | ||
LABEL maintainer.email="[email protected]" | ||
|
||
RUN apt-get update && apt-get install --no-install-recommends -y \ | ||
wget &&\ | ||
apt-get autoclean && rm -rf /var/lib/apt/lists/* | ||
|
||
RUN wget --no-check-certificate https://github.com/bacpop/ska.rust/releases/download/v${SKA2_VER}/ska-v${SKA2_VER}-ubuntu-latest-stable.tar.gz &&\ | ||
tar -C /usr/local/bin -xvf ska-v${SKA2_VER}-ubuntu-latest-stable.tar.gz ska &&\ | ||
rm ska-v${SKA2_VER}-ubuntu-latest-stable.tar.gz | ||
|
||
ENV LC_ALL=C | ||
|
||
CMD [ "ska", "-h" ] | ||
|
||
WORKDIR /data | ||
|
||
## Test ## | ||
FROM app as test | ||
|
||
# force bash to avoid shell errors | ||
SHELL ["/bin/bash", "-c"] | ||
|
||
# adapted from tutorial https://www.bacpop.org/guides/building_trees_with_ska/ | ||
RUN wget --no-check-certificate https://zenodo.org/record/8172518/files/building_trees_with_ska.tar &&\ | ||
tar -xvf building_trees_with_ska.tar assemblies/LA002.fa.gz assemblies/LA022.fa.gz assemblies/LA023.fa.gz assemblies/LA026.fa.gz &&\ | ||
paste <(ls assemblies | sed 's/[.].*$//g') <(ls -d assemblies/*) > laos_ska_input.tsv | ||
|
||
RUN ska build -f laos_ska_input.tsv -k 31 -o laos_ska_index --threads 4 &&\ | ||
ska align --min-freq 1 --filter no-filter laos_ska_index.skf -o laos_ska_alignment.aln --threads 4 &&\ | ||
head -c 1000 laos_ska_alignment.aln &&\ | ||
grep ">" laos_ska_alignment.aln | ||
|
||
|
||
|
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,24 @@ | ||
# SKA2 container | ||
|
||
Main tool: [SKA2](https://github.com/bacpop/ska.rust) | ||
|
||
Code repository: https://github.com/bacpop/ska.rust | ||
|
||
Basic information on how to use this tool: | ||
- executable: ska | ||
- help: -h, --help | ||
- version: -V, --version | ||
- description: SKA2 is a reimplementation of the SKA package in the rust language. Split k-mer analysis (version 2) uses exact matching of split k-mer sequences to align closely related sequences, typically small haploid genomes such as bacteria and viruses. | ||
|
||
Full documentation: https://docs.rs/ska/latest/ska/ | ||
|
||
## Example Usage | ||
|
||
```bash | ||
# Build from two input FASTA files with a k-mer size of 31 | ||
ska build -o seqs -k 31 assemblies/seq1.fa assemblies/seq2.fa | ||
# align | ||
ska align --min-freq 1 --filter no-filter -o seqs seqs.skf | ||
# map | ||
ska map ref.fa seqs.skf -o ref_mapped.aln | ||
``` |