-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathman_0113.html
More file actions
1247 lines (914 loc) · 46.5 KB
/
man_0113.html
File metadata and controls
1247 lines (914 loc) · 46.5 KB
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<title>VCFtools</title>
<link rel="stylesheet" href="stylesheets/styles.css">
<link rel="stylesheet" href="stylesheets/github-light.css">
<script src="javascripts/scale.fix.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
</head>
<body>
<div class="wrapper">
<header>
<h1 class="header">VCFtools</h1>
<p class="header">A set of tools written in Perl and C++ for working with VCF files.</p>
<ul>
<li><a href="index.html">Home</a></li>
<li><a href="examples.html">Documentation</a></li>
<li class="download"><a class="buttons" href="https://github.com/vcftools/vcftools/zipball/master">Download ZIP</a></li>
<li class="download"><a class="buttons" href="https://github.com/vcftools/vcftools/tarball/master">Download TAR</a></li>
<li><a class="buttons github" href="https://github.com/vcftools/vcftools">View On GitHub</a></li>
</ul>
</header>
<section>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#EXAMPLES">EXAMPLES</a><br>
<a href="#BASIC OPTIONS">BASIC OPTIONS</a><br>
<a href="#SITE FILTERING OPTIONS">SITE FILTERING OPTIONS</a><br>
<a href="#INDIVIDUAL FILTERING OPTIONS">INDIVIDUAL FILTERING OPTIONS</a><br>
<a href="#GENOTYPE FILTERING OPTIONS">GENOTYPE FILTERING OPTIONS</a><br>
<a href="#OUTPUT OPTIONS">OUTPUT OPTIONS</a><br>
<a href="#COMPARISON OPTIONS">COMPARISON OPTIONS</a><br>
<a href="#AUTHORS">AUTHORS</a><br>
<hr>
<h2>NAME
<a name="NAME"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">vcftools
v0.1.13 − Utilities for the variant call format (VCF)
and binary variant call format (BCF)</p>
<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><strong>vcftools</strong>
[ <strong>--vcf</strong> FILE | <strong>--gzvcf</strong> FILE | <strong>--bcf</strong>
FILE] [ <strong>--out</strong> OUTPUT PREFIX ] [ FILTERING OPTIONS ] [
OUTPUT OPTIONS ]</p>
<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">vcftools is a
suite of functions for use on genetic variation data in the
form of VCF and BCF files. The tools provided will be used
mainly to summarize data, run calculations on data, filter
out data, and convert data into other useful file
formats.</p>
<h2>EXAMPLES
<a name="EXAMPLES"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">Output allele
frequency for all sites in the input vcf file from
chromosome 1</p>
<p class="codebox" style="margin-left:14%;"><strong>vcftools</strong> --gzvcf
input_file.vcf.gz --freq --chr 1 --out chr1_analysis</p>
<p style="margin-left:11%; margin-top: 1em">Output a new
vcf file from the input vcf file that removes any indel
sites</p>
<p class="codebox" style="margin-left:14%;"><strong>vcftools</strong> --vcf
input_file.vcf --remove-indels --recode --recode-INFO-all
--out SNPs_only</p>
<p style="margin-left:11%; margin-top: 1em">Output file
comparing the sites in two vcf files</p>
<p class="codebox" style="margin-left:14%;"><strong>vcftools</strong> --gzvcf
input_file1.vcf.gz --gzdiff input_file2.vcf.gz --diff-site
--out in1_v_in2</p>
<p style="margin-left:11%; margin-top: 1em">Output a new
vcf file to standard out without any sites that have a
filter tag, then compress it with gzip</p>
<p class="codebox" style="margin-left:14%;"><strong>vcftools</strong> --gzvcf
input_file.vcf.gz --remove-filtered-all --recode --stdout |
gzip -c > output_PASS_only.vcf.gz</p>
<p style="margin-left:11%; margin-top: 1em">Output a
Hardy-Weinberg p-value for every site in the bcf file that
does not have any missing genotypes</p>
<p class="codebox" style="margin-left:14%;"><strong>vcftools</strong> --bcf
input_file.bcf --hardy --max-missing 1.0 --out
output_noMissing</p>
<p style="margin-left:11%; margin-top: 1em">Output
nucleotide diversity at a list of positions</p>
<p class="codebox" style="margin-left:14%;">zcat input_file.vcf.gz |
<strong>vcftools</strong> --vcf - --site-pi --positions SNP_list.txt
--out nucleotide_diversity</p>
<h2>BASIC OPTIONS
<a name="BASIC OPTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">These options
are used to specify the input and output files.</p>
<p style="margin-left:11%; margin-top: 1em"><strong>INPUT FILE
OPTIONS</strong></p>
<p style="margin-left:14%;"><strong>--vcf</strong>
<i><input_filename></i></p>
<p style="margin-left:17%;">This option defines the VCF
file to be processed. VCFtools expects files in VCF format
v4.0, v4.1 or v4.2. The latter two are supported with some
small limitations. If the user provides a dash character
’-’ as a file name, the program expects a VCF
file to be piped in through standard in.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--gzvcf</strong>
<i><input_filename></i></p>
<p style="margin-left:17%;">This option can be used in
place of the --vcf option to read compressed (gzipped) VCF
files directly.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--bcf</strong>
<i><input_filename></i></p>
<p style="margin-left:17%;">This option can be used in
place of the --vcf option to read BCF2 files directly. You
do not need to specify if this file is compressed with BGZF
encoding. If the user provides a dash character
’-’ as a file name, the program expects a BCF2
file to be piped in through standard in.</p>
<p style="margin-left:11%; margin-top: 1em"><strong>OUTPUT FILE
OPTIONS</strong></p>
<p style="margin-left:14%;"><strong>--out</strong>
<i><output_prefix></i></p>
<p style="margin-left:17%;">This option defines the output
filename prefix for all files generated by vcftools. For
example, if <prefix> is set to output_filename, then
all output files will be of the form output_filename.*** .
If this option is omitted, all output files will have the
prefix "out." in the current working
directory.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--stdout
<br>
-c</strong></p>
<p style="margin-left:17%;">These options direct the
vcftools output to standard out so it can be piped into
another program or written directly to a filename of choice.
However, a select few output functions cannot be written to
standard out.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--temp</strong>
<i><temporary_directory></i></p>
<p style="margin-left:17%;">This option can be used to
redirect any temporary files that vcftools creates into a
specified directory.</p>
<h2>SITE FILTERING OPTIONS
<a name="SITE FILTERING OPTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">These options
are used to include or exclude certain sites from any
analysis being performed by the program.</p>
<p style="margin-left:11%; margin-top: 1em"><strong>POSITION
FILTERING</strong></p>
<p style="margin-left:14%;"><strong>--chr</strong>
<i><chromosome></i> <strong><br>
--not-chr</strong> <i><chromosome></i></p>
<p style="margin-left:17%;">Includes or excludes sites with
indentifiers matching <chromosome>. These options may
be used multiple times to include or exclude more than one
chromosome.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--from-bp</strong>
<i><integer></i> <strong><br>
--to-bp</strong> <i><integer></i></p>
<p style="margin-left:17%;">These options specify a lower
bound and upper bound for a range of sites to be processed.
Sites with positions less than or greater than these values
will be excluded. These options can only be used in
conjunction with a single usage of --chr. Using one of these
does not require use of the other.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--positions</strong>
<i><filename></i> <strong><br>
--exclude-positions</strong> <i><filename></i></p>
<p style="margin-left:17%;">Include or exclude a set of
sites on the basis of a list of positions in a file. Each
line of the input file should contain a (tab-separated)
chromosome and position. The file can have comment lines
that start with a "#", they will be ignored.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--positions-overlap</strong>
<i><filename></i> <strong><br>
--exclude-positions-overlap</strong> <i><filename></i></p>
<p style="margin-left:17%;">Include or exclude a set of
sites on the basis of the reference allele overlapping with
a list of positions in a file. Each line of the input file
should contain a (tab-separated) chromosome and position.
The file can have comment lines that start with a
"#", they will be ignored.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--bed</strong>
<i><filename></i> <strong><br>
--exclude-bed</strong> <i><filename></i></p>
<p style="margin-left:17%;">Include or exclude a set of
sites on the basis of a BED file. Only the first three
columns (chrom, chromStart and chromEnd) are required. The
BED file is expected to have a header line. A site will be
kept or excluded if any part of any allele (REF or ALT) at a
site is within the range of one of the BED entries.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--thin</strong>
<i><integer></i></p>
<p style="margin-left:17%;">Thin sites so that no two sites
are within the specified distance from one another.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--mask</strong>
<i><filename></i> <strong><br>
--invert-mask</strong> <i><filename></i> <strong><br>
--mask-min</strong> <i><integer></i></p>
<p style="margin-left:17%;">These options are used to
specify a FASTA-like mask file to filter with. The mask file
contains a sequence of integer digits (between 0 and 9) for
each position on a chromosome that specify if a site at that
position should be filtered or not. <br>
An example mask file would look like:</p>
<p style="margin-left:20%;"><i>>1 <br>
0000011111222... <br>
>2 <br>
2222211111000...</i></p>
<p style="margin-left:17%;">In this example, sites in the
VCF file located within the first 5 bases of the start of
chromosome 1 would be kept, whereas sites at position 6
onwards would be filtered out. And sites after the 11th
position on chromosome 2 would be filtered out as well. <br>
The "--invert-mask" option takes the same format
mask file as the "--mask" option, however it
inverts the mask file before filtering with it. <br>
And the "--mask-min" option specifies a threshold
mask value between 0 and 9 to filter positions by. The
default threshold is 0, meaning only sites with that value
or lower will be kept.</p>
<p style="margin-left:11%; margin-top: 1em"><strong>SITE ID
FILTERING</strong></p>
<p style="margin-left:14%;"><strong>--snp</strong>
<i><string></i></p>
<p style="margin-left:17%;">Include SNP(s) with matching ID
(e.g. a dbSNP rsID). This command can be used multiple times
in order to include more than one SNP.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--snps</strong>
<i><filename></i> <strong><br>
--exclude</strong> <i><filename></i></p>
<p style="margin-left:17%;">Include or exclude a list of
SNPs given in a file. The file should contain a list of SNP
IDs (e.g. dbSNP rsIDs), with one ID per line. No header line
is expected.</p>
<p style="margin-left:11%; margin-top: 1em"><strong>VARIANT TYPE
FILTERING</strong></p>
<p style="margin-left:14%;"><strong>--keep-only-indels <br>
--remove-indels</strong></p>
<p style="margin-left:17%;">Include or exclude sites that
contain an indel. For these options "indel" means
any variant that alters the length of the REF allele.</p>
<p style="margin-left:11%; margin-top: 1em"><strong>FILTER FLAG
FILTERING</strong></p>
<p style="margin-left:14%;"><strong>--remove-filtered-all</strong></p>
<p style="margin-left:17%;">Removes all sites with a FILTER
flag other than PASS.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--keep-filtered</strong>
<i><string></i> <strong><br>
--remove-filtered</strong> <i><string></i></p>
<p style="margin-left:17%;">Includes or excludes all sites
marked with a specific FILTER flag. These options may be
used more than once to specify multiple FILTER flags.</p>
<p style="margin-left:11%; margin-top: 1em"><strong>INFO FIELD
FILTERING</strong></p>
<p style="margin-left:14%;"><strong>--keep-INFO</strong>
<i><string></i> <strong><br>
--remove-INFO</strong> <i><string></i></p>
<p style="margin-left:17%;">Includes or excludes all sites
with a specific INFO flag. These options only filter on the
presence of the flag and not its value. These options can be
used multiple times to specify multiple INFO flags.</p>
<p style="margin-left:11%; margin-top: 1em"><strong>ALLELE
FILTERING</strong></p>
<p style="margin-left:14%;"><strong>--maf</strong>
<i><float></i> <strong><br>
--max-maf</strong> <i><float></i></p>
<p style="margin-left:17%;">Include only sites with a Minor
Allele Frequency greater than or equal to the
"--maf" value and less than or equal to the
"--max-maf" value. One of these options may be
used without the other. Allele frequency is defined as the
number of times an allele appears over all individuals at
that site, divided by the total number of non-missing
alleles at that site.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--non-ref-af</strong>
<i><float></i> <strong><br>
--max-non-ref-af</strong> <i><float></i> <strong><br>
--non-ref-ac</strong> <i><integer></i> <strong><br>
--max-non-ref-ac</strong> <i><integer></i></p>
<p style="margin-left:14%; margin-top: 1em"><strong>--non-ref-af-any</strong>
<i><float></i> <strong><br>
--max-non-ref-af-any</strong> <i><float></i> <strong><br>
--non-ref-ac-any</strong> <i><integer></i> <strong><br>
--max-non-ref-ac-any</strong> <i><integer></i></p>
<p style="margin-left:17%;">Include only sites with all
Non-Reference (ALT) Allele Frequencies (af) or Counts (ac)
within the range specified, and including the specified
value. The default options require <strong>all</strong> alleles to
meet the specified criteria, whereas the options appended
with "any" require only one allele to meet the
criteria. The Allele frequency is defined as the number of
times an allele appears over all individuals at that site,
divided by the total number of non-missing alleles at that
site.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--mac</strong>
<i><integer></i> <strong><br>
--max-mac</strong> <i><integer></i></p>
<p style="margin-left:17%;">Include only sites with Minor
Allele Count greater than or equal to the "--mac"
value and less than or equal to the "--max-mac"
value. One of these options may be used without the other.
Allele count is simply the number of times that allele
appears over all individuals at that site.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--min-alleles</strong>
<i><integer></i> <strong><br>
--max-alleles</strong> <i><integer></i></p>
<p style="margin-left:17%;">Include only sites with a
number of alleles greater than or equal to the
"--min-alleles" value and less than or equal to
the "--max-alleles" value. One of these options
may be used without the other. <br>
For example, to include only bi-allelic sites, one could
use:</p>
<p style="margin-left:20%;"><strong>vcftools</strong> --vcf file1.vcf
--min-alleles 2 --max-alleles 2</p>
<p style="margin-left:11%; margin-top: 1em"><strong>GENOTYPE
VALUE FILTERING</strong></p>
<p style="margin-left:14%;"><strong>--min-meanDP</strong>
<i><float></i> <strong><br>
--max-meanDP</strong> <i><float></i></p>
<p style="margin-left:17%;">Includes only sites with mean
depth values (over all included individuals) greater than or
equal to the "--min-meanDP" value and less than or
equal to the "--max-meanDP" value. One of these
options may be used without the other. These options require
that the "DP" FORMAT tag is included for each
site.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--hwe</strong>
<i><float></i></p>
<p style="margin-left:17%;">Assesses sites for
Hardy-Weinberg Equilibrium using an exact test, as defined
by Wigginton, Cutler and Abecasis (2005). Sites with a
p-value below the threshold defined by this option are taken
to be out of HWE, and therefore excluded.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--max-missing</strong>
<i><float></i></p>
<p style="margin-left:17%;">Exclude sites on the basis of
the proportion of missing data (defined to be between 0 and
1, where 0 allows sites that are completely missing and 1
indicates no missing data allowed).</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--max-missing-count</strong>
<i><integer></i></p>
<p style="margin-left:17%;">Exclude sites with more than
this number of missing genotypes over all individuals.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--phased</strong></p>
<p style="margin-left:17%;">Excludes all sites that contain
unphased genotypes.</p>
<p style="margin-left:11%; margin-top: 1em"><strong>MISCELLANEOUS
FILTERING</strong></p>
<p style="margin-left:14%;"><strong>--minQ</strong>
<i><float></i></p>
<p style="margin-left:17%;">Includes only sites with
Quality value above this threshold.</p>
<h2>INDIVIDUAL FILTERING OPTIONS
<a name="INDIVIDUAL FILTERING OPTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">These options
are used to include or exclude certain individuals from any
analysis being performed by the program.</p>
<p style="margin-left:14%;"><strong>--indv</strong>
<i><string></i> <strong><br>
--remove-indv</strong> <i><string></i></p>
<p style="margin-left:17%;">Specify an individual to be
kept or removed from the analysis. This option can be used
multiple times to specify multiple individuals. If both
options are specified, then the "--indv" option is
executed before the "--remove-indv option".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--keep</strong>
<i><filename></i> <strong><br>
--remove</strong> <i><filename></i></p>
<p style="margin-left:17%;">Provide files containing a list
of individuals to either include or exclude in subsequent
analysis. Each individual ID (as defined in the VCF
headerline) should be included on a separate line. If both
options are used, then the "--keep" option is
executed before the "--remove" option. When
multiple files are provided, the union of individuals from
all keep files subtracted by the union of individuals from
all remove files are kept. No header line is expected.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--max-indv</strong>
<i><integer></i></p>
<p style="margin-left:17%;">Randomly thins individuals so
that only the specified number are retained.</p>
<h2>GENOTYPE FILTERING OPTIONS
<a name="GENOTYPE FILTERING OPTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">These options
are used to exclude genotypes from any analysis being
performed by the program. If excluded, these values will be
treated as missing.</p>
<p style="margin-left:14%;"><strong>--remove-filtered-geno-all</strong></p>
<p style="margin-left:17%;">Excludes all genotypes with a
FILTER flag not equal to "." (a missing value) or
PASS.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--remove-filtered-geno</strong>
<i><string></i></p>
<p style="margin-left:17%;">Excludes genotypes with a
specific FILTER flag.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--minGQ</strong>
<i><float></i></p>
<p style="margin-left:17%;">Exclude all genotypes with a
quality below the threshold specified. This option requires
that the "GQ" FORMAT tag is specified for all
sites.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--minDP</strong>
<i><float></i> <strong><br>
--maxDP</strong> <i><float></i></p>
<p style="margin-left:17%;">Includes only genotypes greater
than or equal to the "--minDP" value and less than
or equal to the "--maxDP" value. This option
requires that the "DP" FORMAT tag is specified for
all sites.</p>
<h2>OUTPUT OPTIONS
<a name="OUTPUT OPTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">These options
specify which analyses or conversions to perform on the data
that passed through all specified filters.</p>
<p style="margin-left:11%; margin-top: 1em"><strong>OUTPUT
ALLELE STATISTICS</strong></p>
<p style="margin-left:14%;"><strong>--freq <br>
--freq2</strong></p>
<p style="margin-left:17%;">Outputs the allele frequency
for each site in a file with the suffix ".frq".
The second option is used to suppress output of any
information about the alleles.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--counts
<br>
--counts2</strong></p>
<p style="margin-left:17%;">Outputs the raw allele counts
for each site in a file with the suffix
".frq.count". The second option is used to
suppress output of any information about the alleles.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--derived</strong></p>
<p style="margin-left:17%;">For use with the previous four
frequency and count options only. Re-orders the output file
columns so that the ancestral allele appears first. This
option relies on the ancestral allele being specified in the
VCF file using the AA tag in the INFO field.</p>
<p style="margin-left:11%; margin-top: 1em"><strong>OUTPUT DEPTH
STATISTICS</strong></p>
<p style="margin-left:14%;"><strong>--depth</strong></p>
<p style="margin-left:17%;">Generates a file containing the
mean depth per individual. This file has the suffix
".idepth".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--site-depth</strong></p>
<p style="margin-left:17%;">Generates a file containing the
depth per site summed across all individuals. This output
file has the suffix ".ldepth".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--site-mean-depth</strong></p>
<p style="margin-left:17%;">Generates a file containing the
mean depth per site averaged across all individuals. This
output file has the suffix ".ldepth.mean".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--geno-depth</strong></p>
<p style="margin-left:17%;">Generates a (possibly very
large) file containing the depth for each genotype in the
VCF file. Missing entries are given the value -1. The file
has the suffix ".gdepth".</p>
<p style="margin-left:11%; margin-top: 1em"><strong>OUTPUT LD
STATISTICS</strong></p>
<p style="margin-left:14%;"><strong>--hap-r2</strong></p>
<p style="margin-left:17%;">Outputs a file reporting the
r2, D, and D’ statistics using phased haplotypes.
These are the traditional measures of LD often reported in
the population genetics literature. The output file has the
suffix ".hap.ld". This option assumes that the VCF
input file has phased haplotypes.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--geno-r2</strong></p>
<p style="margin-left:17%;">Calculates the squared
correlation coefficient between genotypes encoded as 0, 1
and 2 to represent the number of non-reference alleles in
each individual. This is the same as the LD measure reported
by PLINK. The D and D’ statistics are only available
for phased genotypes. The output file has the suffix
".geno.ld".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--geno-chisq</strong></p>
<p style="margin-left:17%;">If your data contains sites
with more than two alleles, then this option can be used to
test for genotype independence via the chi-squared
statistic. The output file has the suffix
".geno.chisq".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--hap-r2-positions</strong>
<i><positions list file></i> <strong><br>
--geno-r2-positions</strong> <i><positions list
file></i></p>
<p style="margin-left:17%;">Outputs a file reporting the r2
statistics of the sites contained in the provided file
verses all other sites. The output files have the suffix
".list.hap.ld" or ".list.geno.ld",
depending on which option is used.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--ld-window</strong>
<i><integer></i></p>
<p style="margin-left:17%;">This optional parameter defines
the maximum number of SNPs between the SNPs being tested for
LD in the "--hap-r2", "--geno-r2", and
"--geno-chisq" functions.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--ld-window-bp</strong>
<i><integer></i></p>
<p style="margin-left:17%;">This optional parameter defines
the maximum number of physical bases between the SNPs being
tested for LD in the "--hap-r2",
"--geno-r2", and "--geno-chisq"
functions.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--ld-window-min</strong>
<i><integer></i></p>
<p style="margin-left:17%;">This optional parameter defines
the minimum number of SNPs between the SNPs being tested for
LD in the "--hap-r2", "--geno-r2", and
"--geno-chisq" functions.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--ld-window-bp-min</strong>
<i><integer></i></p>
<p style="margin-left:17%;">This optional parameter defines
the minimum number of physical bases between the SNPs being
tested for LD in the "--hap-r2",
"--geno-r2", and "--geno-chisq"
functions.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--min-r2</strong>
<i><float></i></p>
<p style="margin-left:17%;">This optional parameter sets a
minimum value for r2, below which the LD statistic is not
reported by the "--hap-r2", "--geno-r2",
and "--geno-chisq" functions.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--interchrom-hap-r2
<br>
--interchrom-geno-r2</strong></p>
<p style="margin-left:17%;">Outputs a file reporting the r2
statistics for sites on different chromosomes. The output
files have the suffix ".interchrom.hap.ld" or
".interchrom.geno.ld", depending on the option
used.</p>
<p style="margin-left:11%; margin-top: 1em"><strong>OUTPUT
TRANSITION/TRANSVERSION STATISTICS</strong></p>
<p style="margin-left:14%;"><strong>--TsTv</strong>
<i><integer></i></p>
<p style="margin-left:17%;">Calculates the Transition /
Transversion ratio in bins of size defined by this option.
Only uses bi-allelic SNPs. The resulting output file has the
suffix ".TsTv".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--TsTv-summary</strong></p>
<p style="margin-left:17%;">Calculates a simple summary of
all Transitions and Transversions. The output file has the
suffix ".TsTv.summary".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--TsTv-by-count</strong></p>
<p style="margin-left:17%;">Calculates the Transition /
Transversion ratio as a function of alternative allele
count. Only uses bi-allelic SNPs. The resulting output file
has the suffix ".TsTv.count".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--TsTv-by-qual</strong></p>
<p style="margin-left:17%;">Calculates the Transition /
Transversion ratio as a function of SNP quality threshold.
Only uses bi-allelic SNPs. The resulting output file has the
suffix ".TsTv.qual".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--FILTER-summary</strong></p>
<p style="margin-left:17%;">Generates a summary of the
number of SNPs and Ts/Tv ratio for each FILTER category. The
output file has the suffix ".FILTER.summary".</p>
<p style="margin-left:11%; margin-top: 1em"><strong>OUTPUT
NUCLEOTIDE DIVERGENCE STATISTICS</strong></p>
<p style="margin-left:14%;"><strong>--site-pi</strong></p>
<p style="margin-left:17%;">Measures nucleotide divergency
on a per-site basis. The output file has the suffix
".sites.pi".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--window-pi</strong>
<i><integer></i> <strong><br>
--window-pi-step</strong> <i><integer></i></p>
<p style="margin-left:17%;">Measures the nucleotide
diversity in windows, with the number provided as the window
size. The output file has the suffix
".windowed.pi". The latter is an optional argument
used to specify the step size in between windows.</p>
<p style="margin-left:11%; margin-top: 1em"><strong>OUTPUT FST
STATISTICS</strong></p>
<p style="margin-left:14%;"><strong>--weir-fst-pop</strong>
<i><filename></i></p>
<p style="margin-left:17%;">This option is used to
calculate an Fst estimate from Weir and Cockerham’s
1984 paper. This is the preferred calculation of Fst. The
provided file must contain a list of individuals (one
individual per line) from the VCF file that correspond to
one population. This option can be used multiple times to
calculate Fst for more than two populations. These files
will also be included as "--keep" options. By
default, calculations are done on a per-site basis. The
output file has the suffix ".weir.fst".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--fst-window-size</strong>
<i><integer></i> <strong><br>
--fst-window-step</strong> <i><integer></i></p>
<p style="margin-left:17%;">These options can be used with
"--weir-fst-pop" to do the Fst calculations on a
windowed basis instead of a per-site basis. These arguments
specify the desired window size and the desired step size
between windows.</p>
<p style="margin-left:11%; margin-top: 1em"><strong>OUTPUT OTHER
STATISTICS</strong></p>
<p style="margin-left:14%;"><strong>--het</strong></p>
<p style="margin-left:17%;">Calculates a measure of
heterozygosity on a per-individual basis. Specfically, the
inbreeding coefficient, F, is estimated for each individual
using a method of moments. The resulting file has the suffix
".het".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--hardy</strong></p>
<p style="margin-left:17%;">Reports a p-value for each site
from a Hardy-Weinberg Equilibrium test (as defined by
Wigginton, Cutler and Abecasis (2005)). The resulting file
(with suffix ".hwe") also contains the Observed
numbers of Homozygotes and Heterozygotes and the
corresponding Expected numbers under HWE.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--TajimaD</strong>
<i><integer></i></p>
<p style="margin-left:17%;">Outputs Tajima’s D
statistic in bins with size of the specified number. The
output file has the suffix ".Tajima.D".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--indv-freq-burden</strong></p>
<p style="margin-left:17%;">This option calculates the
number of variants within each individual of a specific
frequency. The resulting file has the suffix
".ifreqburden".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--LROH</strong></p>
<p style="margin-left:17%;">This option will identify and
output Long Runs of Homozygosity. The output file has the
suffix ".LROH". This function is experimental, and
will use a lot of memory if applied to large datasets.</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--relatedness</strong></p>
<p style="margin-left:17%;">This option is used to
calculate and output a relatedness statistic based on the
method of Yang et al, Nature Genetics 2010
(doi:10.1038/ng.608). Specifically, calculate the unadjusted
Ajk statistic. Expectation of Ajk is zero for individuals
within a populations, and one for an individual with
themselves. The output file has the suffix
".relatedness".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--relatedness2</strong></p>
<p style="margin-left:17%;">This option is used to
calculate and output a relatedness statistic based on the
method of Manichaikul et al., BIOINFORMATICS 2010
(doi:10.1093/bioinformatics/btq559). The output file has the
suffix ".relatedness2".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--site-quality</strong></p>
<p style="margin-left:17%;">Generates a file containing the
per-site SNP quality, as found in the QUAL column of the VCF
file. This file has the suffix ".lqual".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--missing-indv</strong></p>
<p style="margin-left:17%;">Generates a file reporting the
missingness on a per-individual basis. The file has the
suffix ".imiss".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--missing-site</strong></p>
<p style="margin-left:17%;">Generates a file reporting the
missingness on a per-site basis. The file has the suffix
".lmiss".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--SNPdensity</strong>
<i><integer></i></p>
<p style="margin-left:17%;">Calculates the number and
density of SNPs in bins of size defined by this option. The
resulting output file has the suffix
".snpden".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--kept-sites</strong></p>
<p style="margin-left:17%;">Creates a file listing all
sites that have been kept after filtering. The file has the
suffix ".kept.sites".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--removed-sites</strong></p>
<p style="margin-left:17%;">Creates a file listing all
sites that have been removed after filtering. The file has
the suffix ".removed.sites".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--singletons</strong></p>
<p style="margin-left:17%;">This option will generate a
file detailing the location of singletons, and the
individual they occur in. The file reports both true
singletons, and private doubletons (i.e. SNPs where the
minor allele only occurs in a single individual and that
individual is homozygotic for that allele). The output file
has the suffix ".singletons".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--hist-indel-len</strong></p>
<p style="margin-left:17%;">This option will generate a
histogram file of the length of all indels (including SNPs).
It shows both the count and the percentage of all indels for
indel lengths that occur at least once in the input file.
SNPs are considered indels with length zero. The output file
has the suffix ".indel.hist".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--hapcount</strong>
<i><BED file></i></p>
<p style="margin-left:17%;">This option will output the
number of unique haplotypes within user specified bins, as
defined by the BED file. The output file has the suffix
".hapcount".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--mendel</strong>
<i><PED file></i></p>
<p style="margin-left:17%;">This option is use to report
mendel errors identified in trios. The command requires a
PLINK-style PED file, with the first four columns specifying
a family ID, the child ID, the father ID, and the mother ID.
The output of this command has the suffix
".mendel".</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--extract-FORMAT-info</strong>
<i><string></i></p>
<p style="margin-left:17%;">Extract information from the
genotype fields in the VCF file relating to a specfied
FORMAT identifier. The resulting output file has the suffix
".<FORMAT_ID>.FORMAT". For example, the
following command would extract the all of the GT (i.e.
Genotype) entries:</p>
<p style="margin-left:20%;"><strong>vcftools</strong> --vcf file1.vcf
--extract-FORMAT-info GT</p>
<p style="margin-left:14%; margin-top: 1em"><strong>--get-INFO</strong>
<i><string></i></p>
<p style="margin-left:17%;">This option is used to extract
information from the INFO field in the VCF file. The
<string> argument specifies the INFO tag to be
extracted, and the option can be used multiple times in
order to extract multiple INFO entries. The resulting file,
with suffix ".INFO", contains the required INFO
information in a tab-separated table. For example, to