bcftools/bcftools.1

   1 .TH bcftools 1 "16 March 2011" "bcftools" "Bioinformatics tools"
   2 .SH NAME
   3 .PP
   4 bcftools - Utilities for the Binary Call Format (BCF) and VCF.
   5 .SH SYNOPSIS
   6 .PP
   7 bcftools index in.bcf
   8 .PP
   9 bcftools view in.bcf chr2:100-200 > out.vcf
  10 .PP
  11 bcftools view -vc in.bcf > out.vcf 2> out.afs
  12
  13 .SH DESCRIPTION
  14 .PP
  15 Bcftools is a toolkit for processing VCF/BCF files, calling variants and
  16 estimating site allele frequencies and allele frequency spectrums.
  17
  18 .SH COMMANDS AND OPTIONS
  19
  20 .TP 10
  21 .B view
  22 .B bcftools view
  23 .RB [ \-AbFGNQSucgv ]
  24 .RB [ \-D
  25 .IR seqDict ]
  26 .RB [ \-l
  27 .IR listLoci ]
  28 .RB [ \-s
  29 .IR listSample ]
  30 .RB [ \-i
  31 .IR gapSNPratio ]
  32 .RB [ \-t
  33 .IR mutRate ]
  34 .RB [ \-p
  35 .IR varThres ]
  36 .RB [ \-P
  37 .IR prior ]
  38 .RB [ \-1
  39 .IR nGroup1 ]
  40 .RB [ \-U
  41 .IR nPerm ]
  42 .RB [ \-X
  43 .IR permThres ]
  44 .I in.bcf
  45 .RI [ region ]
  46
  47 Convert between BCF and VCF, call variant candidates and estimate allele
  48 frequencies.
  49
  50 .RS
  51 .TP
  52 .B Input/Output Options:
  53 .TP 10
  54 .B -A
  55 Retain all possible alternate alleles at variant sites. By default, the view
  56 command discards unlikely alleles.
  57 .TP 10
  58 .B -b
  59 Output in the BCF format. The default is VCF.
  60 .TP
  61 .BI -D \ FILE
  62 Sequence dictionary (list of chromosome names) for VCF->BCF conversion [null]
  63 .TP
  64 .B -F
  65 Indicate PL is generated by r921 or before (ordering is different).
  66 .TP
  67 .B -G
  68 Suppress all individual genotype information.
  69 .TP
  70 .BI -l \ FILE
  71 List of sites at which information are outputted [all sites]
  72 .TP
  73 .B -N
  74 Skip sites where the REF field is not A/C/G/T
  75 .TP
  76 .B -Q
  77 Output the QCALL likelihood format
  78 .TP
  79 .BI -s \ FILE
  80 List of samples to use. In the output, the ordering of samples will be identical
  81 to the one in
  82 .IR FILE .
  83 [null]
  84 .TP
  85 .B -S
  86 The input is VCF instead of BCF.
  87 .TP
  88 .B -u
  89 Uncompressed BCF output (force -b).
  90 .TP
  91 .B Consensus/Variant Calling Options:
  92 .TP 10
  93 .B -c
  94 Call variants.
  95 .TP
  96 .B -g
  97 Call per-sample genotypes at variant sites (force -c)
  98 .TP
  99 .BI -i \ FLOAT
 100 Ratio of INDEL-to-SNP mutation rate [0.15]
 101 .TP
 102 .BI -p \ FLOAT
 103 A site is considered to be a variant if P(ref|D)<FLOAT [0.5]
 104 .TP
 105 .BI -P \ STR
 106 Prior or initial allele frequency spectrum. If STR can be
 107 .IR full ,
 108 .IR cond2 ,
 109 .I flat
 110 or the file consisting of error output from a previous variant calling
 111 run.
 112 .TP
 113 .BI -t \ FLOAT
 114 Scaled muttion rate for variant calling [0.001]
 115 .TP
 116 .B -v
 117 Output variant sites only (force -c)
 118 .TP
 119 .B Contrast Calling and Association Test Options:
 120 .TP
 121 .BI -1 \ INT
 122 Number of group-1 samples. This option is used for dividing the samples into
 123 two groups for contrast SNP calling or association test.
 124 When this option is in use, the following VCF INFO will be outputted:
 125 PC2, PCHI2 and QCHI2. [0]
 126 .TP
 127 .BI -U \ INT
 128 Number of permutations for association test (effective only with
 129 .BR -1 )
 130 [0]
 131 .TP
 132 .BI -X \ FLOAT
 133 Only perform permutations for P(chi^2)<FLOAT (effective only with
 134 .BR -U )
 135 [0.01]
 136 .RE
 137
 138 .TP
 139 .B index
 140 .B bcftools index
 141 .I in.bcf
 142
 143 Index sorted BCF for random access.
 144 .RE
 145
 146 .TP
 147 .B cat
 148 .B bcftools cat
 149 .I in1.bcf
 150 .RI [ "in2.bcf " [ ... "]]]"
 151
 152 Concatenate BCF files. The input files are required to be sorted and
 153 have identical samples appearing in the same order.
 154 .RE
 155
 156 .SH BCFTOOLS SPECIFIC VCF TAGS
 157
 158 .TS
 159 center box;
 160 cb | cb | cb
 161 l | l | l .
 162 Tag     Format  Description
 163 _
 164 AF1     double  Max-likelihood estimate of the site allele frequency (AF) of the first ALT allele
 165 CI95    double[2]       Equal-tail Bayesian credible interval of AF at the 95% level
 166 DP      int     Raw read depth (without quality filtering)
 167 DP4     int[4]  # high-quality reference forward bases, ref reverse, alternate for and alt rev bases
 168 FQ      int     Consensus quality. Positive: sample genotypes different; negative: otherwise
 169 MQ      int     Root-Mean-Square mapping quality of covering reads
 170 PC2     int[2]  Phred probability of AF in group1 samples being larger (,smaller) than in group2
 171 PCHI2   double  Posterior weighted chi^2 P-value between group1 and group2 samples
 172 PV4     double[4]       P-value for strand bias, baseQ bias, mapQ bias and tail distance bias
 173 QCHI2   int     Phred-scaled PCHI2
 174 RP      int     # permutations yielding a smaller PCHI2
 175 .TE