Skip to content
This repository has been archived by the owner on May 5, 2020. It is now read-only.

Latest commit

 

History

History
158 lines (117 loc) · 5.78 KB

installation.md

File metadata and controls

158 lines (117 loc) · 5.78 KB
Raw

nf-core/vipr installation

To start using the nf-core/vipr pipeline, follow the steps below:

  1. Install Nextflow
  2. Install the pipeline
  3. Pipeline configuration
  4. Parameters

1) Install NextFlow

Nextflow runs on most POSIX systems (Linux, Mac OSX etc). It can be installed by running the following commands:

# Make sure that Java v8+ is installed:
java -version

# Install Nextflow
curl -fsSL get.nextflow.io | bash

# Add Nextflow binary to your PATH:
mv nextflow ~/bin
# OR system-wide installation:
# sudo mv nextflow /usr/local/bin

See nextflow.io for further instructions on how to install and configure Nextflow.

2) Install the pipeline

2.1) Automatic

This pipeline itself needs no installation - NextFlow will automatically fetch it from GitHub if nf-core/vipr is specified as the pipeline name.

2.2) Offline

The above method requires an internet connection so that Nextflow can download the pipeline files. If you're running on a system that has no internet connection, you'll need to download and transfer the pipeline files manually:

# Download the latest release of the pipeline (see https://github.com/nf-core/vipr/releases)
curl -L https://github.com/nf-core/vipr/archive/1.0.zip -o nf-core-vipr-v1.0.zip
unzip nf-core-vipr-v1.0.zip
cd /path/to/my/data
nextflow run /path/to/pipelines/nf-core-vipr-v1.0 [parameters]

2.3) Development

If you would like to make changes to the pipeline, it's best to make a fork on GitHub and then clone the files. Once cloned you can run the pipeline directly as above.

3) Pipeline configuration

By default, the pipeline runs with the standard configuration profile. This uses a number of sensible defaults for process requirements and is suitable for running on a simple (if powerful!) basic server. You can see this configuration in conf/base.config.

Be warned of two important points about this default configuration:

  1. The default profile uses the local executor
    • All jobs are run in the login session. If you're using a simple server, this may be fine. If you're using a compute cluster, this is bad as all jobs will run on the head node.
    • See the nextflow docs for information about running with other hardware backends. Most job scheduler systems are natively supported.
  2. Nextflow will expect all software to be installed and available on the PATH

3.1) Software deps: Docker and Singularity

Running the pipeline with the option -with-singularity or -with-docker tells Nextflow to enable either Singularity or Docker for this run. An image containing all of the software requirements will be automatically fetched and used (https://hub.docker.com/r/nf-core/vipr).

If running offline with Singularity, you'll need to download and transfer the Singularity image first:

singularity pull --name nfcore-vipr-[VERSION].simg shub://nfcore/vipr:[VERSION]

Once transferred, use -with-singularity but specify the path to the image file:

nextflow run /path/to/nf-core-vipr -with-singularity /path/to/nfcore-vipr-[VERSION].simg

3.2) Software deps: bioconda

If you're unable to use either Docker or Singularity but you have conda installed, you can use the bioconda environment that comes with the pipeline. Running this command will create a new conda environment with all of the required software installed:

conda env create -f environment.yml
conda clean -a # Recommended, not essential
source activate nfcore-vipr-1.0 # Name depends on version

The environment.yml file is packaged with the pipeline. Note that you may need to download this file from the GitHub project page if nextflow is automatically fetching the pipeline files. Ensure that the bioconda environment file version matches the pipeline version that you run.

3.3) Configuration profiles

Nextflow can be configured to run on a wide range of different computational infrastructures. In addition to the above pipeline-specific parameters it is likely that you will need to define system-specific options. For more information, please see the Nextflow documentation.

Whilst most parameters can be specified on the command line, it is usually sensible to create a configuration file for your environment.

If you are the only person to be running this pipeline, you can create your config file as ~/.nextflow/config and it will be applied every time you run Nextflow. Alternatively, save the file anywhere and reference it when running the pipeline with -c path/to/config.

If you think that there are other people using the pipeline who would benefit from your configuration (eg. other common cluster setups), please let us know. We can add a new configuration and profile which can used by specifying -profile <name> when running the pipeline.

The pipeline comes with several such config profiles - see the installation appendices and usage documentation for more information.

4) Reference files

The nf-core/vipr pipeline requires

  • a viral reference genome for read alignment
  • a host reference genome for decontamination (needs to be BWA indexed)
  • a Kraken database for read classification

See also usage documentation