Skip to content

Commit afab061

Browse files
erinyoungKincekara
andauthored
Adding fastplong (#1162)
* adding fastplong * adding fastplong version 0.2.2 * fixed hardcoded version * Update Dockerfile line 54: wget -q --------- Co-authored-by: Kutluhan Incekara <46578029+Kincekara@users.noreply.github.com>
1 parent 1e9f1ea commit afab061

File tree

4 files changed

+79
-0
lines changed

4 files changed

+79
-0
lines changed

Program_Licenses.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ The licenses of the open-source software that is contained in these Docker image
5555
| FastANI | Apache v2.0 | https://github.com/ParBLiSS/FastANI/blob/master/LICENSE |
5656
| fasten | MIT | https://github.com/lskatz/fasten/blob/master/LICENSE |
5757
| Fastp | MIT | https://github.com/OpenGene/fastp/blob/master/LICENSE |
58+
| Fastplong | MIT | https://github.com/OpenGene/fastplong/blob/main/LICENSE |
5859
| FastTree | GNU GPLv2 | http://www.microbesonline.org/fasttree/ |
5960
| FastQC | GNU GPLv3 | https://github.com/s-andrews/FastQC/blob/master/LICENSE.txt |
6061
| fastq-scan | MIT | https://github.com/rpetit3/fastq-scan/blob/master/LICENSE |

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,7 @@ To learn more about the docker pull rate limits and the open source software pro
166166
| [FastANI](https://hub.docker.com/r/staphb/fastani) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/fastani)](https://hub.docker.com/r/staphb/fastani) | <ul><li>1.1</li><li>1.32</li><li>1.33</li><li>1.33 + RGDv2</li><li>[1.34](fastani/1.34)</li><li>[1.34 + RGDv2](fastani/1.34-RGDV2/)</li></ul> | https://github.com/ParBLiSS/FastANI |
167167
| [fasten](https://hub.docker.com/r/staphb/fasten) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/fasten)](https://hub.docker.com/r/staphb/fasten) | <ul><li>[0.7.2](./fasten/0.7.2)</li><li>[0.8.1](./fasten/0.8.1/)</li></ul> | https://github.com/lskatz/fasten |
168168
| [Fastp](https://hub.docker.com/r/staphb/fastp) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/fastp)](https://hub.docker.com/r/staphb/fastp) | <ul><li>0.23.2</li><li>[0.23.4](fastp/0.23.4/)</li><li>[0.24.0](./fastp/0.24.0/)</li></ul> | http://opengene.org/fastp/ <br/> https://github.com/OpenGene/fastp |
169+
| [fastplong](https://hub.docker.com/r/staphb/fastplong) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/fastplong)](https://hub.docker.com/r/staphb/fastplong) | <ul><li>[0.2.2](./build-files/fastplong/0.2.2/)</li></ul> | https://github.com/OpenGene/fastplong |
169170
| [FastTree](https://hub.docker.com/r/staphb/fasttree) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/fasttree)](https://hub.docker.com/r/staphb/fasttree) | <ul><li>2.1.11</li></ul> | http://www.microbesonline.org/fasttree/ |
170171
| [FastQC](https://hub.docker.com/r/staphb/fastqc) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/fastqc)](https://hub.docker.com/r/staphb/fastqc) | <ul><li>0.11.8</li><li>0.11.9</li><li>0.12.1</li></ul> | https://www.bioinformatics.babraham.ac.uk/projects/fastqc/ <br/> https://github.com/s-andrews/FastQC |
171172
| [fastq-scan](https://hub.docker.com/r/staphb/fastq-scan) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/fastq-scan)](https://hub.docker.com/r/staphb/fastq-scan) | <ul><li>0.4.3</li><li>0.4.4</li><li>1.0.0</li><li>1.0.1</li></ul> | https://github.com/rpetit3/fastq-scan |
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
ARG FASTPLONG_VER="0.2.2"
2+
3+
FROM ubuntu:jammy AS app
4+
5+
# List all software versions are ARGs near the top of the dockerfile
6+
# 'ARG' sets environment variables during the build stage
7+
# ARG variables are ONLY available during image build, they do not persist in the final image
8+
ARG FASTPLONG_VER
9+
10+
# 'LABEL' instructions tag the image with metadata that might be important to the user
11+
LABEL base.image="ubuntu:jammy"
12+
LABEL dockerfile.version="1"
13+
LABEL software="fastplong"
14+
LABEL software.version="${FASTPLONG_VER}"
15+
LABEL description="Ultrafast preprocessing and quality control for long reads"
16+
LABEL website="https://github.com/OpenGene/fastplong"
17+
LABEL license="https://github.com/OpenGene/fastplong/blob/main/LICENSE"
18+
LABEL maintainer="Erin Young"
19+
LABEL maintainer.email="eriny@utah.gov"
20+
21+
# 'RUN' executes code during the build
22+
# Install dependencies via apt-get or yum if using a centos or fedora base
23+
RUN apt-get update && apt-get install -y --no-install-recommends \
24+
libdeflate-dev \
25+
libisal-dev \
26+
libhwy-dev \
27+
wget && \
28+
apt-get autoclean && rm -rf /var/lib/apt/lists/*
29+
30+
RUN wget --no-check-certificate -q http://opengene.org/fastplong/fastplong.${FASTPLONG_VER} && \
31+
mv fastplong.${FASTPLONG_VER} /usr/local/bin/fastplong && \
32+
chmod a+x /usr/local/bin/fastplong
33+
34+
# 'CMD' instructions set a default command when the container is run. This is typically 'tool --help.'
35+
CMD [ "fastplong", "--help" ]
36+
37+
# 'WORKDIR' sets working directory
38+
WORKDIR /data
39+
40+
##### ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- #####
41+
##### Step 2. Set up the testing stage. #####
42+
##### The docker image is built to the 'test' stage before merging, but #####
43+
##### the test stage (or any stage after 'app') will be lost. #####
44+
##### ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- #####
45+
46+
# A second FROM insruction creates a new stage
47+
FROM app AS test
48+
49+
# set working directory so that all test inputs & outputs are kept in /test
50+
WORKDIR /test
51+
52+
RUN fastplong --help
53+
54+
RUN wget --no-check-certificate -q https://zenodo.org/records/10733190/files/df_test_files.tar.gz && \
55+
tar -xvf df_test_files.tar.gz && \
56+
fastplong -i test_files/test.fastq.gz -o filtered.test.fastq.gz && \
57+
ls filtered.test.fastq.gz
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# fastplong container
2+
3+
Main tool: [fastplong](https://github.com/OpenGene/fastplong)
4+
5+
Code repository: https://github.com/OpenGene/fastplong
6+
7+
Basic information on how to use this tool:
8+
- executable: fastplong
9+
- help: --help
10+
- version: --version
11+
- description: |
12+
> Ultrafast preprocessing and quality control for long reads (Nanopore, PacBio, Cyclone, etc.).
13+
14+
Full documentation: https://github.com/OpenGene/fastplong
15+
16+
## Example Usage
17+
18+
```bash
19+
fastplong -i input.fastq.gz -o output.fastq.gz
20+
```

0 commit comments

Comments
 (0)