epi2me-labs / wf-cnv

Other
9 stars 2 forks source link
This Oxford Nanopore Technologies repo is deprecated.

Deprecated

wf-cnv was deprecated at version 0.0.9. The functionality of wf-cnv is now available in wf-human-variation.

wf-cnv

This repository contains a Nextflow workflow for carrying out copy number analysis, using a read depth method implemented by the R package QDNAseq. The input to the workflow is either sequence data in FASTQ or BAM format, and the output per sample is an HTML report containing chromosome copy summary, ideoplot, plot of read counts per bin, links to genes in detected CNVs, and QC data. The workflow also produces read statistics, a BAM alignment file (if FASTQ was provided as input), BED files of both raw and normalised read counts, and a VCF file.

Please note, currently CNV calling is restricted to human genome builds hg19 and hg38. For more information about the workflow, please see this EPI2ME labs blog post.

Introduction

The workflow takes BAM or FASTQ data, aligns to a reference genome (if FASTQ files are supplied), and uses the R package QDNAseq to call copy number aberrations.

Best practices for human copy number calling are actively being investigated by the ONT applications team, and this workflow puts some of that work into something that can be easily used by our community.

wf-cnv also utilises our new reporting and plotting package ezcharts. This uses Python dominate and an Apache echart API to allow us to make modern, responsive layouts and plots with relative ease.

Quickstart

The workflow uses Nextflow to manage compute and software resources, and as such Nextflow will need to be installed before attempting to run the workflow.

The workflow can currently be run using either Docker or Singularity to provide isolation of the required software. Both methods are automated out-of-the-box provided either Docker or Singularity is installed.

It is not required to clone or download the git repository in order to run the workflow. For more information on running EPI2ME Labs workflows visit our website.

Workflow options

To obtain the workflow, having installed nextflow, users can run:

nextflow run epi2me-labs/wf-cnv --help

to see the options for the workflow.

Example command (BAM):

nextflow run epi2me-labs/wf-cnv --bam <PATH_TO_BAM> --bin_size <BIN_SIZE>

Example command (FASTQ):

nextflow run epi2me-labs/wf-cnv --fastq <PATH_TO_FASTQS> --reference <PATH_TO_REFERENCE> --bin_size <BIN_SIZE>

The FASTQs for three test samples are available here and can be used with the the accompanying sample sheet from here.

Example command with test data:

nextflow run epi2me-labs/wf-cnv --fastq <PATH_TO_DOWNLOADED_FASTQ> --sample_sheet <PATH_TO_DOWNLOADED_SAMPLE_SHEET> --reference /path/to/hg38.fa.gz --bin_size 500

Workflow outputs

The primary outputs of the workflow include, per sample:

Reference

Scheinin I, Sie D, Bengtsson H, van de Wiel MA, Olshen AB, van Thuijl HF, van Essen HF, Eijk PP, Rustenburg F, Meijer GA, Reijneveld JC, Wesseling P, Pinkel D, Albertson DG, Ylstra B. DNA copy number analysis of fresh and formalin-fixed specimens by shallow whole-genome sequencing with identification and exclusion of problematic regions in the genome assembly. Genome Res. 2014 Dec;24(12):2022-32. doi: 10.1101/gr.175141.114. Epub 2014 Sep 18. PMCID