-
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.
- Loading branch information
Showing
3 changed files
with
86 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,67 @@ | ||
| FROM mambaorg/micromamba:1.5.7 AS app | ||
|
|
||
| # Version arguments | ||
| # ARG variables only persist during build time | ||
| # THIS ARG ONLY USED FOR A LABEL. VERSION SPECIFIED IN PANAROO-ENVIRONMENT.YML | ||
| ARG PANAROO_SOFTWARE_VERSION="1.5.1" | ||
|
|
||
| # build and run as root users since micromamba image has 'mambauser' set as the $USER | ||
| USER root | ||
| # set workdir to default for building; set to /data at the end | ||
| WORKDIR / | ||
|
|
||
| LABEL base.image="mambaorg/micromamba:1.5.7" | ||
| LABEL dockerfile.version="1" | ||
| LABEL software="Panaroo" | ||
| LABEL software.version=${PANAROO_SOFTWARE_VERSION} | ||
| LABEL description="An updated pipeline for pangenome investigation" | ||
| LABEL website="https://github.com/gtonkinhill/panaroo" | ||
| LABEL license="https://github.com/gtonkinhill/panaroo/blob/master/LICENSE" | ||
| LABEL maintainer="Kevin Libuit" | ||
| LABEL maintainer.email="[email protected]" | ||
| LABEL maintainer2="Erin Young" | ||
| LABEL maintainer2.email="[email protected]" | ||
|
|
||
| # install dependencies; cleanup apt garbage | ||
| RUN apt-get update && apt-get install -y --no-install-recommends \ | ||
| wget \ | ||
| ca-certificates \ | ||
| procps && \ | ||
| apt-get autoclean && rm -rf /var/lib/apt/lists/* | ||
|
|
||
| # Install Panaroo conda environment into base environment | ||
| # clean up conda garbage | ||
| # conda environment includes optional tools prokka, prank, mafft, clustal, and mash | ||
| RUN micromamba install -y -n base -c conda-forge -c bioconda -c defaults python=3.9 panaroo=${PANAROO_SOFTWARE_VERSION} && \ | ||
| micromamba clean -a -f -y | ||
|
|
||
| # set the environment, put new conda env in PATH by default | ||
| ENV PATH="/opt/conda/bin:/opt/conda/envs/base/bin:${PATH}" \ | ||
| LC_ALL=C.UTF-8 | ||
|
|
||
| # set working directory to /data | ||
| WORKDIR /data | ||
|
|
||
| # set default command | ||
| CMD panaroo -h | ||
|
|
||
| # new base for testing | ||
| FROM app AS test | ||
|
|
||
| # checks to see if tool is in PATH | ||
| RUN panaroo --version && panaroo -h | ||
|
|
||
| WORKDIR /test | ||
|
|
||
| # Grab test data from 1.2.10 | ||
| RUN wget -q https://raw.githubusercontent.com/StaPH-B/docker-builds/master/panaroo/1.2.10/tests/ecoli_1.gff && \ | ||
| wget -q https://raw.githubusercontent.com/StaPH-B/docker-builds/master/panaroo/1.2.10/tests/ecoli_2.gff && \ | ||
| wget -q https://raw.githubusercontent.com/StaPH-B/docker-builds/master/panaroo/1.2.10/tests/gene_data.csv && \ | ||
| wget -q https://raw.githubusercontent.com/StaPH-B/docker-builds/master/panaroo/1.2.10/tests/summary_statistics.txt | ||
|
|
||
| # Run Panaroo | ||
| RUN panaroo --clean-mode strict -i *.gff -o panaroo_results/ | ||
|
|
||
| RUN head panaroo_results/summary_statistics.txt && \ | ||
| head summary_statistics.txt && \ | ||
| cmp summary_statistics.txt panaroo_results/summary_statistics.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,18 @@ | ||
| # Panaroo Container | ||
|
|
||
| Main tool : [Panaroo](https://github.com/gtonkinhill/panaroo) | ||
|
|
||
| Full documentation: https://gtonkinhill.github.io/panaroo/#/ | ||
|
|
||
| Panaroo is an updated pipeline for pangenome investigation. | ||
|
|
||
| [Tonkin-Hill G, MacAlasdair N, Ruis C, Weimann A, Horesh G, Lees JA, Gladstone RA, Lo S, Beaudoin C, Floto RA, Frost SDW, Corander J, Bentley SD, Parkhill J. 2020. Producing polished prokaryotic pangenomes with the Panaroo pipeline. Genome Biol 21:180.](https://genomebiology.biomedcentral.com/articles/10.1186/s13059-020-02090-4) | ||
|
|
||
|
|
||
| ## Example Usage | ||
|
|
||
| ```bash | ||
| # Using GFFs in the same format as output by Prokka run: | ||
| mkdir results | ||
| panaroo -i *.gff -o results --clean-mode strict | ||
| ``` |