Description

Generates stats from VCF files

Input

name:type
description
pattern

meta{:bash}

:map

Groovy Map containing sample information e.g. [ id:‘test’, single_end:false ]

vcf{:bash}

:file

VCF input file

*.{vcf}

tbi{:bash}

:file

The tab index for the VCF file to be inspected. Optional: only required when parameter regions is chosen.

*.tbi

meta2{:bash}

:map

Groovy Map containing sample information e.g. [ id:‘test’, single_end:false ]

regions{:bash}

:file

Optionally, restrict the operation to regions listed in this file. (VCF, BED or tab-delimited)

meta3{:bash}

:map

Groovy Map containing sample information e.g. [ id:‘test’, single_end:false ]

targets{:bash}

:file

Optionally, restrict the operation to regions listed in this file (doesn’t rely upon tbi index files)

meta4{:bash}

:map

Groovy Map containing sample information e.g. [ id:‘test’, single_end:false ]

samples{:bash}

:file

Optional, file of sample names to be included or excluded. e.g. ‘file.tsv’

meta5{:bash}

:map

Groovy Map containing sample information e.g. [ id:‘test’, single_end:false ]

exons{:bash}

:file

Tab-delimited file with exons for indel frameshifts (chr,beg,end; 1-based, inclusive, optionally bgzip compressed). e.g. ‘exons.tsv.gz’

meta6{:bash}

:map

Groovy Map containing sample information e.g. [ id:‘test’, single_end:false ]

fasta{:bash}

:file

Faidx indexed reference sequence file to determine INDEL context. e.g. ‘reference.fa’

Output

name:type
description
pattern

stats{:bash}

meta{:bash}

:map

Groovy Map containing sample information e.g. [ id:‘test’, single_end:false ]

*stats.txt{:bash}

:file

Text output file containing stats

*_{stats.txt}

versions_bcftools{:bash}

${task.process}{:bash}

:string

The process the versions were collected from

bcftools{:bash}

:string

The tool name

bcftools --version | sed '1!d; s/^.*bcftools //'{:bash}

:string

The command used to generate the version of the tool

Topics

name:type
description
pattern

versions{:bash}

${task.process}{:bash}

:string

The process the versions were collected from

bcftools{:bash}

:string

The tool name

bcftools --version | sed '1!d; s/^.*bcftools //'{:bash}

:string

The command used to generate the version of the tool

Tools

stats
MIT

Parses VCF or BCF and produces text file stats which is suitable for machine processing and can be plotted using plot-vcfstats.