bcftools/bcftools.1

   1 .TH bcftools 1 "2 October 2010" "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 [ \-cbuSAGgHvNQ ]
  24 .RB [ \-1
  25 .IR nGroup1 ]
  26 .RB [ \-l
  27 .IR listFile ]
  28 .RB [ \-t
  29 .IR mutRate ]
  30 .RB [ \-p
  31 .IR varThres ]
  32 .RB [ \-P
  33 .IR prior ]
  34 .I in.bcf
  35 .RI [ region ]
  36
  37 Convert between BCF and VCF, call variant candidates and estimate allele
  38 frequencies.
  39
  40 .B OPTIONS:
  41 .RS
  42 .TP 10
  43 .B -b
  44 Output in the BCF format. The default is VCF.
  45 .TP
  46 .B -c
  47 Call variants.
  48 .TP
  49 .B -v
  50 Output variant sites only (force -c)
  51 .TP
  52 .B -g
  53 Call per-sample genotypes at variant sites (force -c)
  54 .TP
  55 .B -u
  56 Uncompressed BCF output (force -b).
  57 .TP
  58 .B -S
  59 The input is VCF instead of BCF.
  60 .TP
  61 .B -A
  62 Retain all possible alternate alleles at variant sites. By default, this
  63 command discards unlikely alleles.
  64 .TP
  65 .B -G
  66 Suppress all individual genotype information.
  67 .TP
  68 .B -H
  69 Perform Hardy-Weiberg Equilibrium test. This will add computation time, sometimes considerably.
  70 .TP
  71 .B -N
  72 Skip sites where the REF field is not A/C/G/T
  73 .TP
  74 .B -Q
  75 Output the QCALL likelihood format
  76 .TP
  77 .B -f
  78 Reference-free variant calling mode. In this mode, the prior will be
  79 folded; a variant is called iff the sample(s) contains at least two
  80 alleles; the QUAL field in the VCF/BCF output is changed accordingly.
  81 .TP
  82 .BI "-1 " INT
  83 Number of group-1 samples. This option is used for dividing input into
  84 two groups for comparing. A zero value disables this functionality. [0]
  85 .TP
  86 .BI "-l " FILE
  87 List of sites at which information are outputted [all sites]
  88 .TP
  89 .BI "-t " FLOAT
  90 Scaled muttion rate for variant calling [0.001]
  91 .TP
  92 .BI "-p " FLOAT
  93 A site is considered to be a variant if P(ref|D)<FLOAT [0.5]
  94 .TP
  95 .BI "-P " STR
  96 Prior or initial allele frequency spectrum. If STR can be
  97 .IR full ,
  98 .IR cond2 ,
  99 .I flat
 100 or the file consisting of error output from a previous variant calling
 101 run.
 102 .RE
 103
 104 .TP
 105 .B index
 106 .B bcftools index
 107 .I in.bcf
 108
 109 Index sorted BCF for random access.
 110 .RE
 111
 112 .TP
 113 .B cat
 114 .B bcftools cat
 115 .I in1.bcf
 116 .RI [ "in2.bcf " [ ... "]]]"
 117
 118 Concatenate BCF files. The input files are required to be sorted and
 119 have identical samples appearing in the same order.
 120 .RE