If running the pipeline in a local environment, we highly recommend using either Docker or Singularity.
Docker is a great way to run NF-toxomix, as it manages all software installations and allows the pipeline to be run in an identical software environment across a range of systems.
Nextflow has excellent integration with Docker, and beyond installing the two tools, not much else is required. The NF-toxomix profile comes with a configuration profile for docker, making it very easy to use. This also comes with the required presets to use the AWS iGenomes resource, meaning that if using common reference genomes you just specify the reference ID and it will be autaomtically downloaded from AWS S3.
First, install docker on your system: Docker Installation Instructions
Then, simply run the analysis pipeline:
nextflow run skptic/NF-toxomix -profile docker --reads '<path to your reads>'Nextflow will recognise skptic/NF-toxomix and download the pipeline from GitHub. The -profile docker configuration lists the nf-toxomix image that we have created and is hosted at dockerhub, and this is downloaded.
For more information about how to work with reference genomes, see docs/configuration/reference_genomes.md.
The public docker images are tagged with the same version numbers as the code, which you can use to ensure reproducibility. When running the pipeline, specify the pipeline version with -r, for example -r v1.3. This uses pipeline code and docker image from this tagged version.
Many HPC environments are not able to run Docker due to security issues. Singularity is a tool designed to run on such HPC systems which is very similar to Docker. Even better, it can use create images directly from dockerhub.
To use the singularity image for a single run, use -with-singularity 'docker://nf-toxomix'. This will download the docker container from dockerhub and create a singularity image for you dynamically.
If you intend to run the pipeline offline, nextflow will not be able to automatically download the singularity image for you. Instead, you'll have to do this yourself manually first, transfer the image file and then point to that.
First, pull the image file where you have an internet connection:
singularity pull --name nf-toxomix.img docker://nf-toxomixThen transfer this file and run the pipeline with this path:
nextflow run /path/to/NF-toxomix -with-singularity /path/to/nf-toxomix.img