annotate ezBAMQC/src/htslib/vcf.5 @ 17:161866cee2a2

wrapper rename
author youngkim
date Wed, 30 Mar 2016 13:28:47 -0400
parents dfa3745e5fd8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
1 '\" t
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
2 .TH vcf 5 "August 2013" "htslib" "Bioinformatics formats"
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
3 .SH NAME
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
4 vcf \- Variant Call Format
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
5 .\"
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
6 .\" Copyright (C) 2011 Broad Institute.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
7 .\" Copyright (C) 2013 Genome Research Ltd.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
8 .\"
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
9 .\" Author: Heng Li <lh3@sanger.ac.uk>
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
10 .\"
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
11 .\" Permission is hereby granted, free of charge, to any person obtaining a
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
12 .\" copy of this software and associated documentation files (the "Software"),
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
13 .\" to deal in the Software without restriction, including without limitation
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
14 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
15 .\" and/or sell copies of the Software, and to permit persons to whom the
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
16 .\" Software is furnished to do so, subject to the following conditions:
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
17 .\"
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
18 .\" The above copyright notice and this permission notice shall be included in
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
19 .\" all copies or substantial portions of the Software.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
20 .\"
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
21 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
22 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
23 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
24 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
25 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
26 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
27 .\" DEALINGS IN THE SOFTWARE.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
28 .\"
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
29 .SH DESCRIPTION
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
30 The Variant Call Format (VCF) is a TAB-delimited format with each data line
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
31 consisting of the following fields:
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
32 .TS
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
33 nlbl.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
34 1 CHROM CHROMosome name
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
35 2 POS the left-most POSition of the variant
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
36 3 ID unique variant IDentifier
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
37 4 REF the REFerence allele
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
38 5 ALT the ALTernate allele(s) (comma-separated)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
39 6 QUAL variant/reference QUALity
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
40 7 FILTER FILTERs applied
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
41 8 INFO INFOrmation related to the variant (semicolon-separated)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
42 9 FORMAT FORMAT of the genotype fields (optional; colon-separated)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
43 10+ SAMPLE SAMPLE genotypes and per-sample information (optional)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
44 .TE
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
45 .P
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
46 The following table gives the \fBINFO\fP tags used by samtools and bcftools.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
47 .TP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
48 .B AF1
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
49 Max-likelihood estimate of the site allele frequency (AF) of the first ALT allele
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
50 (double)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
51 .TP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
52 .B DP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
53 Raw read depth (without quality filtering)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
54 (int)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
55 .TP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
56 .B DP4
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
57 # high-quality reference forward bases, ref reverse, alternate for and alt rev bases
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
58 (int[4])
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
59 .TP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
60 .B FQ
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
61 Consensus quality. Positive: sample genotypes different; negative: otherwise
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
62 (int)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
63 .TP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
64 .B MQ
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
65 Root-Mean-Square mapping quality of covering reads
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
66 (int)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
67 .TP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
68 .B PC2
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
69 Phred probability of AF in group1 samples being larger (,smaller) than in group2
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
70 (int[2])
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
71 .TP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
72 .B PCHI2
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
73 Posterior weighted chi^2 P-value between group1 and group2 samples
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
74 (double)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
75 .TP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
76 .B PV4
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
77 P-value for strand bias, baseQ bias, mapQ bias and tail distance bias
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
78 (double[4])
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
79 .TP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
80 .B QCHI2
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
81 Phred-scaled PCHI2
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
82 (int)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
83 .TP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
84 .B RP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
85 # permutations yielding a smaller PCHI2
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
86 (int)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
87 .TP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
88 .B CLR
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
89 Phred log ratio of genotype likelihoods with and without the trio/pair constraint
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
90 (int)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
91 .TP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
92 .B UGT
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
93 Most probable genotype configuration without the trio constraint
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
94 (string)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
95 .TP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
96 .B CGT
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
97 Most probable configuration with the trio constraint
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
98 (string)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
99 .TP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
100 .B VDB
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
101 Tests variant positions within reads. Intended for filtering RNA-seq artifacts around splice sites
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
102 (float)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
103 .TP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
104 .B RPB
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
105 Mann-Whitney rank-sum test for tail distance bias
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
106 (float)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
107 .TP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
108 .B HWE
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
109 Hardy-Weinberg equilibrium test (Wigginton et al)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
110 (float)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
111 .P
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
112 .SH SEE ALSO
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
113 .TP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
114 https://github.com/samtools/hts-specs
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
115 The full VCF/BCF file format specification
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
116 .TP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
117 .I A note on exact tests of Hardy-Weinberg equilibrium
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
118 Wigginton JE et al
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
119 PMID:15789306
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
120 .\" (http://www.ncbi.nlm.nih.gov/pubmed/15789306)