iarcbioinfo/vcf_normalization-nf

Sponsored OSS

By International Agency for Research on Cancer

Updated about 6 years ago

Container with dependencies for vcf_normalization-nf

Image
Integration & delivery
Data science
0

3.1K

iarcbioinfo/vcf_normalization-nf repository overview

vcf_normalization-nf

Nextflow pipeline for vcf normalization

Workflow representation

Description

Apply bcftools norm to decompose and normalize variants from a set of VCF (compressed with gzip/bgzip).

This scripts takes a set of a folder containing compressed VCF files (*.vcf.gz) as an input. It consists at four piped steps:

  • (optional) filtering of variants (bcftoolvs view -f)
  • split multiallelic sites into biallelic records (bcftools norm -m -) and left-alignment and normalization (-f ref)
  • sorting (bcftools sort )
  • duplicate removal (bcftools norm -d exact) and compression (-Oz)

Dependencies

  1. This pipeline is based on nextflow. As we have several nextflow pipelines, we have centralized the common information in the IARC-nf repository. Please read it carefully as it contains essential information for the installation, basic usage and configuration of nextflow and our pipelines.

  2. External software:

Caution: bcftools has to be in your $PATH. Try each of the commands bcftools and bgzip, if it returns the options this is ok.

Input

NameDescription
--vcf_folderFolder containing tumor zipped VCF files

Parameters

NameExample valueDescription
--ref/path/to/ref.fastaReference fasta file indexed
NameDefault valueDescription
--output_foldernormalized_VCF/Folder to output resulting compressed vcf
--filter_opt-f PASSOptions for bcftools view
--cpu2Number of cpus to use
--mem8Size of memory used for mapping (in GB)

Note that the default is to filter variants with the PASS flag. To deactivate, use --filter_opt " ".

Flags are special parameters without value.

NameDescription
--helpDisplay help

Usage

Simple use case example:

nextflow run iarcbioinfo/vcf_normalization-nf -r v1.1 -profile singularity --vcf_folder VCF/ --ref ref.fasta

To run the pipeline without singularity just remove "-profile singularity". Alternatively, one can run the pipeline using a docker container (-profile docker) the conda receipe containing all required dependencies (-profile conda).

Output

TypeDescription
VCF.gz, VCF.gz.tbiCompressed normalized VCF files with indexes

Contributions

NameEmailDescription
Nicolas Alcala*[email protected]Developer to contact for support
Tiffany Delhomme[email protected]Developer

Tag summary

Content type

Image

Digest

Size

240.1 MB

Last updated

about 6 years ago

docker pull iarcbioinfo/vcf_normalization-nf:v1.1

This week's pulls

Pulls:

204

Last week