Skip to content

Latest commit

 

History

History
95 lines (54 loc) · 7.54 KB

README.md

File metadata and controls

95 lines (54 loc) · 7.54 KB
Raw

nf-core/reveal nf-core/reveal

Nextflow

run with docker run with singularity

Follow on TwitterWatch on YouTube

Introduction

REVEAL is a bioinformatics best-practice pipeline that automates the preparation of tracks, regions of interest and configurations to generate images containing data of interest for further analysis.

The pipeline is built using Nextflow, a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It uses Docker/Singularity containers making installation trivial and results highly reproducible. The Nextflow DSL2 implementation of this pipeline uses one container per process which makes it much easier to maintain and update software dependencies. Where possible, these processes have been submitted to and installed from nf-core/modules in order to make them available to all nf-core pipelines, and to everyone within the Nextflow community!

On release, automated continuous integration tests run the pipeline on a full-sized dataset on the AWS cloud infrastructure. This ensures that the pipeline runs on AWS, has sensible resource allocation defaults set to run on real-world datasets, and permits the persistent storage of results to benchmark between pipeline releases and other analysis sources.The results obtained from the full-sized test can be viewed on the nf-core website.

Pipeline summary

Pipeline Overview

  1. Tracks and regions pre-processing:

    Tracks (BAM, VCF, or BED Files), regions of interest (BED files), flanking window values (slops), and additional options are pre-processed to produce smaller files and expanded regions before generating the images.

  2. Configuration:

    Depending of the backend (default IGV-Snapshots), configuration files are generated (e.g. IGV Session files and batch commands)

  3. Images generation

    Pre-processed tracks, regions of interest, additional options, and configuration files are used to proudce images of the selected regions.

Quick Start

  1. Install Nextflow (>=21.10.3)

  2. Install any of Docker, Singularity (you can follow this tutorial), Podman, Shifter or Charliecloud for full pipeline reproducibility (you can use Conda both to install Nextflow itself and also to manage software within pipelines. Please only use it within pipelines as a last resort; see docs).

  3. Download the pipeline and test it on a minimal dataset with a single command:

    nextflow run nf-core/reveal -profile test,YOURPROFILE --outdir <OUTDIR>

    Note that some form of configuration will be needed so that Nextflow knows how to fetch the required software. This is usually done in the form of a config profile (YOURPROFILE in the example command above). You can chain multiple config profiles in a comma-separated string.

    • The pipeline comes with config profiles called docker and singularity which instruct the pipeline to use the named tool for software management. For example, -profile docker.
    • Please check nf-core/configs to see if a custom config file to run nf-core pipelines already exists for your Institute. If so, you can simply use -profile <institute> in your command. This will enable either docker or singularity and set the appropriate execution settings for your local compute environment.
    • If you are using singularity, please use the nf-core download command to download images first, before running the pipeline. Setting the NXF_SINGULARITY_CACHEDIR or singularity.cacheDir Nextflow options enables you to store and re-use the images from a central location for future pipeline runs.
    • If you are using conda, it is highly recommended to use the NXF_CONDA_CACHEDIR or conda.cacheDir settings to store the environments in a central location for future pipeline runs.

  4. Start running your own analysis!

    nextflow run gariem/nf-core-reveal --input config.yaml --outdir <OUTDIR> --fasta <REFERENCE_PATH> -profile <docker/singularity>

Documentation

The nf-core/reveal pipeline comes with documentation about the pipeline usage and output.

Credits

nf-core/reveal was originally written by Emilio Garcia @gariem.

Contributions and Support

If you would like to contribute to this pipeline, please see the contributing guidelines.

Citations

If you use nf-core/reveal for your analysis, please cite it using the following doi: 10.5281/zenodo.7336272

An extensive list of references for the tools used by the pipeline can be found in the CITATIONS.md file.

You can cite the nf-core publication as follows:

The nf-core framework for community-curated bioinformatics pipelines.

Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.

Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x.