README.md

Introduction

nf-cmgg/exomecnv is a bioinformatics pipeline that can be used to call copy number variations (CNVs) from exome sequencing data with ExomeDepth and annotate these with EnsemblVEP. It takes a samplesheet with cram or bam files and their index files as input, generates read count data, calls CNVs and ends with an annotation. It is also possible to take a samplesheet with VCF files and their index files as input and only execute the annotation.

Pipeline Summary

1. Convert CRAM to BAM if CRAM files are provided (optional)
2. ExomeDepth counting per sample (autosomal and chrX separated)
3. Merge count files per pool (autosomal and chrX stay separated)
4. ExomeDepth CNV calling per sample (autosomal and chrX stay separated)
5. Merge CNV calling files per sample (autosomal and chrX are merged)
6. Convert merged files to VCF
7. Generate index files for these VCF files
8. Annotate VCF files with EnsemblVEP

Usage

Note

If you are new to Nextflow and nf-core, please refer to this page on how to set-up Nextflow. Make sure to test your setup with -profile test before running the workflow on actual data.

First, prepare a samplesheet with your input data that looks as follows:

samplesheet.csv:

sample,pool,family,cram,crai,vcf,tbi
sample1,poolM,Fam1,/path/to/sample1.cram,/path/to/sample1.crai
sample2,poolF,Fam2,/path/to/sample2.cram,/path/to/sample2.crai,/path/to/sample2.vcf,/path/to/sample2.vcf.tbi

Each row represents a sample with the associated pool and family, followed by the optional paths to the CRAM/CRAI or VCF/TBI files, depending on which tasks should be executed.

Now, you can run the pipeline using:

nextflow run nf-cmgg/exomecnv \
   -profile <docker/conda> \
   --input /path/to/samplesheet.csv \
   --outdir /path/to/outdir \
   --vep_cache /path/to/vep_cache \
   --exomedepth \
   --annotate

to execute the ExomeDepth workflow, followed by an EnsemblVEP annotation on CRAM/CRAI (or BAM/BAI) files provided in the samplesheet. The --annotate parameter is optional. If not provided, only the ExomeDepth workflow will be executed. It is also possible to run the pipeline using:

nextflow run nf-cmgg/exomecnv \
   -profile <docker/conda> \
   --input /path/to/samplesheet.csv \
   --outdir /path/to/outdir \
   --vep_cache /path/to/vep_cache

to skip the ExomeDepth workflow and only execute the EnsemblVEP annotation on VCF/TBI files provided in the samplesheet.

Warning

Please provide pipeline parameters via the CLI or Nextflow -params-file option. Custom config files including those provided by the -c Nextflow option can be used to provide any configuration except for parameters; see docs.

Credits

nf-cmgg/exomecnv was originally written by nvnieuwk.

We thank the following people for their extensive assistance in the development of this pipeline:

Contributions and Support

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

Citations

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

This pipeline uses code and infrastructure developed and maintained by the nf-core community, reused here under the MIT license.

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.