-
Notifications
You must be signed in to change notification settings - Fork 125
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
225 additions
and
2 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| FROM ubuntu:focal as app | ||
|
|
||
| # for easy upgrade later. ARG variables only persist during image build time. | ||
| ARG NANOPLOT_VER="1.41.6" | ||
|
|
||
| LABEL base.image="ubuntu:focal" | ||
| LABEL dockerfile.version="1" | ||
| LABEL software="nanoplot" | ||
| LABEL software.version="${NANOPLOT_VER}" | ||
| LABEL description="Plotting suite for Oxford Nanopore sequencing data and alignments" | ||
| LABEL website="https://github.com/wdecoster/NanoPlot" | ||
| LABEL license="https://github.com/wdecoster/NanoPlot/blob/master/LICENSE" | ||
| LABEL maintainer="Curtis Kapsak" | ||
| LABEL maintainer.email="[email protected]" | ||
| LABEL maintainer2="Kate Prussing" | ||
| LABEL maintainer2.email="[email protected]" | ||
|
|
||
| # install dependencies via apt; cleanup apt garbage; set locale to en_US.UTF-8 | ||
| RUN apt-get update && apt-get install -y zlib1g-dev \ | ||
| bzip2 \ | ||
| libbz2-dev \ | ||
| liblzma-dev \ | ||
| libcurl4-gnutls-dev \ | ||
| libncurses5-dev \ | ||
| libssl-dev \ | ||
| python3 \ | ||
| python3-pip \ | ||
| python3-setuptools \ | ||
| locales && \ | ||
| locale-gen en_US.UTF-8 && \ | ||
| apt-get autoclean && rm -rf /var/lib/apt/lists/* | ||
|
|
||
| # for singularity compatibility | ||
| ENV LC_ALL=C | ||
|
|
||
| # install NanoPlot via pypi using pip3; make /data directory | ||
| RUN pip3 install matplotlib psutil requests NanoPlot==${NANOPLOT_VER} && \ | ||
| mkdir /data | ||
|
|
||
| WORKDIR /data | ||
|
|
||
| # testing layer | ||
| FROM app as test | ||
|
|
||
| # print help options and version | ||
| RUN NanoPlot --help && NanoPlot --version | ||
|
|
||
| # install wget for downloading test data | ||
| RUN apt-get update && apt-get install -y wget | ||
|
|
||
| # download ONT data for a Salmonella isolate, run NanoPlot on the FASTQ file | ||
| # Go here for more info: https://www.ebi.ac.uk/ena/browser/view/SRR19787768?show=reads | ||
| RUN wget https://ftp.sra.ebi.ac.uk/vol1/fastq/SRR197/068/SRR19787768/SRR19787768_1.fastq.gz && \ | ||
| NanoPlot --fastq SRR19787768_1.fastq.gz --log --N50 -o /data/nanoplot-test && \ | ||
| ls -lh /data/nanoplot-test && \ | ||
| cat /data/nanoplot-test/NanoStats.txt |
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,19 @@ | ||
| # NanoPlot container | ||
|
|
||
| Main tool : [NanoPlot](https://github.com/wdecoster/NanoPlot) | ||
|
|
||
| Additional tools: | ||
|
|
||
| - nanomath 1.3.0 | ||
| - nanoget 1.19.3 | ||
|
|
||
| Full documentation: [https://github.com/wdecoster/NanoPlot](https://github.com/wdecoster/NanoPlot) | ||
|
|
||
| Plotting tool for long read sequencing data and alignments. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```bash | ||
| # pass in the sequencing_summary.txt file produced by Guppy/Dorado basecaller | ||
| NanoPlot --summary sequencing_summary.txt --N50 --loglength -t 4 -o nanoplot-out | ||
| ``` |
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,110 @@ | ||
| ARG QUAST_VER="5.2.0" | ||
|
|
||
| ## Builder ## | ||
| FROM ubuntu:focal as builder | ||
|
|
||
| ARG QUAST_VER | ||
|
|
||
| # define timezone to avoid build stalls | ||
| ENV TZ=America/New_York | ||
| RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone | ||
|
|
||
| RUN apt-get update && apt-get install --no-install-recommends -y \ | ||
| wget \ | ||
| python2 \ | ||
| perl \ | ||
| cpanminus \ | ||
| g++ \ | ||
| make \ | ||
| openjdk-8-jre-headless \ | ||
| r-base \ | ||
| pkg-config \ | ||
| libfreetype6-dev \ | ||
| libpng-dev \ | ||
| libboost-all-dev \ | ||
| locales &&\ | ||
| locale-gen en_US.UTF-8 &&\ | ||
| cpanm Time::HiRes &&\ | ||
| apt-get autoclean &&\ | ||
| rm -rf /var/lib/apt/lists/* | ||
|
|
||
| # python dependencies | ||
| RUN update-alternatives --install /usr/bin/python python /usr/bin/python2 1 &&\ | ||
| wget https://bootstrap.pypa.io/pip/2.7/get-pip.py && python get-pip.py &&\ | ||
| pip install --no-cache matplotlib simplejson joblib | ||
|
|
||
| # install quast | ||
| RUN wget https://github.com/ablab/quast/releases/download/quast_${QUAST_VER}/quast-${QUAST_VER}.tar.gz && \ | ||
| tar -xzf quast-${QUAST_VER}.tar.gz && \ | ||
| rm -rf quast-${QUAST_VER}.tar.gz && \ | ||
| cd /quast-${QUAST_VER} && \ | ||
| /quast-${QUAST_VER}/setup.py install | ||
|
|
||
| # add GRIDSS for SV detection | ||
| ADD https://github.com/ablab/quast/raw/master/external_tools/gridss/gridss-1.4.1.jar /quast-${QUAST_VER}/quast_libs/gridss/ | ||
|
|
||
| ## App ## | ||
| FROM ubuntu:focal as app | ||
|
|
||
| ARG QUAST_VER | ||
|
|
||
| LABEL base.image="ubuntu:focal" | ||
| LABEL dockerfile.version="1" | ||
| LABEL software="QUAST" | ||
| LABEL software.version=${QUAST_VER} | ||
| LABEL description="Genome assembly evaluation tool" | ||
| LABEL website="https://github.com/ablab/quast" | ||
| LABEL license="https://github.com/ablab/quast/blob/master/LICENSE.txt" | ||
| LABEL maintainer="Curtis Kapsak" | ||
| LABEL maintainer.email="[email protected]" | ||
| LABEL maintainer2="Kutluhan Incekara" | ||
| LABEL maintainer2.email="[email protected]" | ||
|
|
||
| # define timezone to avoid build stalls | ||
| ENV TZ=America/New_York | ||
| RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone | ||
|
|
||
| # install only necessary programs and libraries to run quast | ||
| RUN apt-get update && apt-get install --no-install-recommends -y \ | ||
| wget \ | ||
| python2 \ | ||
| perl \ | ||
| openjdk-8-jre-headless \ | ||
| r-base \ | ||
| libidn11 \ | ||
| locales &&\ | ||
| locale-gen en_US.UTF-8 &&\ | ||
| apt-get autoclean &&\ | ||
| rm -rf /var/lib/apt/lists/* | ||
|
|
||
| # python dependencies | ||
| RUN update-alternatives --install /usr/bin/python python /usr/bin/python2 1 &&\ | ||
| wget https://bootstrap.pypa.io/pip/2.7/get-pip.py && python get-pip.py &&\ | ||
| pip install --no-cache matplotlib simplejson joblib | ||
| # copy quast and compiled tools | ||
| COPY --from=builder /quast-${QUAST_VER} /quast-${QUAST_VER} | ||
| # copy compiled Time::HiRes perl module | ||
| COPY --from=builder /usr/local/lib/x86_64-linux-gnu/perl/5.30.0/Time/ /usr/local/lib/x86_64-linux-gnu/perl/5.30.0/Time/ | ||
|
|
||
| ENV LC_ALL=C | ||
| ENV PATH=$PATH:/quast-${QUAST_VER} | ||
|
|
||
| CMD quast.py --help && quast-lg.py --help && metaquast.py --help | ||
|
|
||
| WORKDIR /data | ||
|
|
||
| ## Test ## | ||
| FROM app as test | ||
| # test quast | ||
| RUN quast.py --test-sv && mv ./quast_test_output/ ./quast_test_sv_output/ | ||
| # test quast-lg | ||
| RUN quast-lg.py --test && mv ./quast_test_output/ ./quast_test_lg_output/ | ||
| # test metaquast | ||
| RUN metaquast.py --test | ||
| # check logs | ||
| RUN tail -n5 ./quast_test_sv_output/quast.log &&\ | ||
| tail -n5 ./quast_test_lg_output/quast.log &&\ | ||
| tail -n5 ./quast_test_output/metaquast.log | ||
|
|
||
| # Note 1: "Warnings are GenMark license related. They disappear when a valid licence is provided." | ||
| # Note 2: "metaquast.py --test-no-ref" throws error related Krona plot (known bug of Quast 5.2.0) |
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,36 @@ | ||
| # QUAST container | ||
|
|
||
| Main tool: [QUAST](https://github.com/ablab/quast) | ||
|
|
||
| Code repository: https://github.com/ablab/quast | ||
|
|
||
| Additional tools: | ||
| - gridss: 1.4.1 | ||
|
|
||
|
|
||
| Basic information on how to use this tool: | ||
| - executable: quast.py | ||
| - help: --help | ||
| - version: --version | ||
| - description: Genome assembly evaluation tool | ||
|
|
||
| Additional information: | ||
|
|
||
| You need a license key if you want to use GeneMark with Quast!<br> | ||
| The key can be downloaded from http://exon.gatech.edu/GeneMark/license_download.cgi page (GeneMark is free for non-commercial use). | ||
| You should choose GeneMarkS-T LINUX 64. Download your license key and add it to your data folder or another folder you will bind to the container. Inside the container, copy the key to your home folder. | ||
| ``` | ||
| cp /data/gm_key_64 ~/.gm_key | ||
| ``` | ||
| Full documentation: https://quast.sourceforge.net/docs/manual.html | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```bash | ||
| # basic statistics without reference | ||
| quast.py contigs.fasta | ||
| # genome evaluation with reference | ||
| quast.py contigs.fasta -r reference.fasta.gz -g genes.gff | ||
| # metagenomic assemblies | ||
| metaquast.py contigs_1 contigs_2 ... -r reference_1,reference_2,reference_3,... | ||
| ``` |