diff --git a/Program_Licenses.md b/Program_Licenses.md index 02e0a02ee..ed99d0213 100644 --- a/Program_Licenses.md +++ b/Program_Licenses.md @@ -74,6 +74,7 @@ The licenses of the open-source software that is contained in these Docker image | Mummer | The Artistic License 2.0| https://github.com/mummer4/mummer/blob/master/LICENSE.md | | Mykrobe | MIT | https://github.com/Mykrobe-tools/mykrobe/blob/master/LICENSE | | NanoPlot | GNU GPLv3 | https://github.com/wdecoster/NanoPlot/blob/master/LICENSE | +| ncov-recombinant | MIT | https://github.com/ktmeaton/ncov-recombinant/blob/master/LICENSE | | NCBI AMRFinderPlus | Public Domain | https://github.com/ncbi/amr/blob/master/LICENSE | | NCBI Datasets | Public Domain | https://github.com/ncbi/datasets/blob/master/pkgs/ncbi-datasets-cli/LICENSE.md | | NCBI table2asn | Public Domain | unknown | diff --git a/README.md b/README.md index 861d51789..eeb026223 100644 --- a/README.md +++ b/README.md @@ -99,9 +99,10 @@ To learn more about the docker pull rate limits and the open source software pro | [mlst](https://hub.docker.com/r/staphb/mlst)
[![docker pulls](https://badgen.net/docker/pulls/staphb/mlst)](https://hub.docker.com/r/staphb/mlst) | | https://github.com/tseemann/mlst | | [Mugsy](https://hub.docker.com/r/staphb/mugsy)
[![docker pulls](https://badgen.net/docker/pulls/staphb/mugsy)](https://hub.docker.com/r/staphb/mugsy) | | http://mugsy.sourceforge.net/ | | [MultiQC](https://hub.docker.com/r/staphb/multiqc)
[![docker pulls](https://badgen.net/docker/pulls/staphb/multiqc)](https://hub.docker.com/r/staphb/multiqc) | | https://github.com/ewels/MultiQC | -| [Mummer](https://hub.docker.com/r/staphb/mummer)
[![docker pulls](https://badgen.net/docker/pulls/staphb/mummer)](https://hub.docker.com/r/staphb/mummer) | | https://github.com/mummer4/mummer | -| [Mykrobe + Genotyphi + sonneityping](https://hub.docker.com/r/staphb/mykrobe)
[![docker pulls](https://badgen.net/docker/pulls/staphb/mykrobe)](https://hub.docker.com/r/staphb/mykrobe) | | https://github.com/Mykrobe-tools/mykrobe
https://github.com/katholt/genotyphi
https://github.com/katholt/sonneityping | -| [NanoPlot](https://hub.docker.com/r/staphb/nanoplot)
[![docker pulls](https://badgen.net/docker/pulls/staphb/nanoplot)](https://hub.docker.com/r/staphb/nanoplot) | | https://github.com/wdecoster/NanoPlot | +| [Mummer](https://hub.docker.com/r/staphb/mummer)
[![docker pulls](https://badgen.net/docker/pulls/staphb/mummer)](https://hub.docker.com/r/staphb/mummer) | | https://github.com/mummer4/mummer | +| [Mykrobe + Genotyphi](https://hub.docker.com/r/staphb/mykrobe)
[![docker pulls](https://badgen.net/docker/pulls/staphb/mykrobe)](https://hub.docker.com/r/staphb/mykrobe) | | https://github.com/Mykrobe-tools/mykrobe
https://github.com/katholt/genotyphi | +| [NanoPlot](https://hub.docker.com/r/staphb/nanoplot)
[![docker pulls](https://badgen.net/docker/pulls/staphb/nanoplot)](https://hub.docker.com/r/staphb/nanoplot) | | https://github.com/wdecoster/NanoPlot | +| [ncov-recombinant](https://hub.docker.com/r/staphb/nanoplot)
[![docker pulls](https://badgen.net/docker/pulls/staphb/ncov-recombinant)](https://hub.docker.com/r/staphb/ncov-recombinant) | | https://github.com/ktmeaton/ncov-recombinant | | [ngmaster](https://hub.docker.com/r/staphb/ngmaster)
[![docker pulls](https://badgen.net/docker/pulls/staphb/ngmaster)](https://hub.docker.com/r/staphb/ngmaster) | | https://github.com/MDU-PHL/ngmaster | | [NCBI Datasets](https://hub.docker.com/r/staphb/ncbi-datasets)
[![docker pulls](https://badgen.net/docker/pulls/staphb/ncbi-datasets)](https://hub.docker.com/r/staphb/ncbi-datasets) | | [https://github.com/ncbi/datasets](https://github.com/ncbi/datasets)
[https://www.ncbi.nlm.nih.gov/datasets/docs/v1/](https://www.ncbi.nlm.nih.gov/datasets/docs/v1/) | | [NCBI AMRFinderPlus](https://hub.docker.com/r/staphb/ncbi-amrfinderplus)
[![docker pulls](https://badgen.net/docker/pulls/staphb/ncbi-amrfinderplus)](https://hub.docker.com/r/staphb/ncbi-amrfinderplus) | | [https://github.com/ncbi/amr](https://github.com/ncbi/amr) | @@ -205,6 +206,7 @@ Each Dockerfile lists the author(s)/maintainer(s) as a metadata `LABEL`, but the * [@tiverson](https://github.com/tives82) * [@sbthandras](https://github.com/sbthandras) * [@idolawoye](https://github.com/idolawoye) + * [@whottel](https://github.com/whottel) * [@michellescribner](https://github.com/michellescribner) * [@cjjossart](https://github.com/cjjossart) * [@jlumpe](https://github.com/jlumpe) diff --git a/ncov-recombinant/0.6.1/Dockerfile b/ncov-recombinant/0.6.1/Dockerfile new file mode 100644 index 000000000..12eb3acea --- /dev/null +++ b/ncov-recombinant/0.6.1/Dockerfile @@ -0,0 +1,52 @@ +ARG ncov_recombinant_version='0.6.1' +FROM mambaorg/micromamba:0.24.0 as app +ARG ncov_recombinant_version +USER root + +WORKDIR / + +#metadata +LABEL base.image="FROM mambaorg/micromamba:0.24.0" +LABEL dockerfile.version="1" +LABEL software="ncov-recombinant" +LABEL software.version="v${ncov_recombinant_version}" +LABEL description="SARS-CoV-2 recombinant sequence detection" +LABEL website="https://github.com/ktmeaton/ncov-recombinant" +LABEL license="https://github.com/ktmeaton/ncov-recombinant/blob/master/LICENSE" +LABEL maintainer="Wes Hottel" +LABEL maintainer.email="wesley-hottel@uiowa.edu" + +#Install dependencies +RUN apt-get update && apt-get install --no-install-recommends -y python \ + git \ + procps \ + wget && \ + rm -rf /var/lib/apt/lists/* && apt-get autoclean + +#Clone ncov-recombinant repository +RUN wget https://github.com/ktmeaton/ncov-recombinant/archive/refs/tags/v${ncov_recombinant_version}.tar.gz && \ +tar zxf v${ncov_recombinant_version}.tar.gz && \ +rm -rf v${ncov_recombinant_version}.tar.gz + +#Install ncov-recombinant +RUN micromamba create -n ncov-recombinant-env -f /ncov-recombinant-${ncov_recombinant_version}/workflow/envs/environment.yaml &&\ +micromamba clean -a -y + +#Set environment +ENV PATH="/opt/conda/envs/ncov-recombinant-env/bin:/opt/conda/envs/env/bin:${PATH}" \ + LC_ALL=C.UTF-8 + +WORKDIR /data + +#Test install using postive controls included as part of repo +FROM app as test +ARG ncov_recombinant_version + +WORKDIR /ncov-recombinant-${ncov_recombinant_version} + +ENV ENV_NAME="ncov-recombinant-env" +ARG MAMBA_DOCKERFILE_ACTIVATE=1 + +RUN snakemake --profile /ncov-recombinant-${ncov_recombinant_version}/profiles/controls-positive + +WORKDIR /data diff --git a/ncov-recombinant/0.6.1/README.md b/ncov-recombinant/0.6.1/README.md new file mode 100644 index 000000000..6e83dfa6b --- /dev/null +++ b/ncov-recombinant/0.6.1/README.md @@ -0,0 +1,18 @@ +# ncov-recombinant container + +Main tool : [ncov-recombinant](https://github.com/ktmeaton/ncov-recombinant) + +ncov-recombinant is a recombinant sequence detection tool for SARS-CoV-2 fasta files. +This tool: +1) Aligns sequences and performs clade/lineage assignments with Nextclade +2) Identifies parental clades and plots recombination breakpoints with sc2rf. +3) Creates tables, plots, and powerpoint slides for reporting. + +When using this Dockerfile please make sure that you are using a WORKDIR that is mounted to your system. +https://bioinformatics.stackexchange.com/questions/9129/access-workdir-defined-on-command-line-from-within-snakefile + +## Example Usage + +```bash +snakemake --directory WORKDIR --profile /ncov-recombinant/profiles/controls +```