File: vcftools.md

package info (click to toggle)
multiqc 1.9%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 27,568 kB
  • sloc: python: 28,657; javascript: 3,233; sh: 74; makefile: 24
file content (40 lines) | stat: -rw-r--r-- 1,470 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
---
Name: VCFTools
URL: https://vcftools.github.io
Description: VCFTools is a program for working with and reporting on VCF files.
---

### Important General Note
* Depending on the size and density of the variant data (vcf),
  some of the stat files generated by vcftools can be very large. 
  If you find that some of your input files are missing, increase 
  the [config.log_filesize_limit](http://multiqc.info/docs/#big-log-files)
  so that the large file(s) will not be skipped by MultiQC. Note, however, 
  that this might make MultiQC very slow!

This module parses the outputs from VCFTools' various commands:

### Implemented
* `relatedness2`
  * Plots a heatmap of pairwise sample relatedness.
  * Not to be confused with the similarly-named command `relatedness`
* `TsTv-by-count`
  * Plots the transition to transversion ratio as a function of 
    alternative allele count (using only bi-allelic SNPs).
* `TsTv-by-qual`
  * Plots the transition to transversion ratio as a function of SNP 
    quality threshold (using only bi-allelic SNPs).
* `TsTv-summary`
  * Plots a bargraph of the summary counts of each type of transition and 
    transversion SNPs. 

### To do
VCFTools has a number of outputs not yet supported in MultiQC which
would be good to add. Please check GitHub if you'd like these added
or (better still), would like to contribute!

* basic stats
* relatedness
* freq
* depth
* [Everything else](https://vcftools.github.io/man_latest.html)