File: vcfannotate.1

package info (click to toggle)
libvcflib 1.0.2%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 49,732 kB
  • sloc: cpp: 39,194; perl: 474; python: 321; ruby: 285; sh: 247; ansic: 198; makefile: 125; javascript: 94; lisp: 55
file content (48 lines) | stat: -rw-r--r-- 1,002 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
41
42
43
44
45
46
47
48
.\" Automatically generated by Pandoc 2.7.3
.\"
.TH "VCFANNOTATE" "1" "" "vcfannotate (vcflib)" "vcfannotate (VCF transformation)"
.hy
.SH NAME
.PP
\f[B]vcfannotate\f[R]
.SH SYNOPSIS
.PP
\f[B]vcfannotate\f[R] options []
.SH DESCRIPTION
.PP
Intersect the records in the VCF file with targets provided in a BED
file.
Intersections are done on the reference sequences in the VCF file.
If no VCF filename is specified on the command line (last argument) the
VCF read from stdin.
.SH OPTIONS
.IP
.nf
\f[C]


options:
    -b, --bed   use annotations provided by this BED file
    -k, --key   use this INFO field key for the annotations
    -d, --default  use this INFO field key for records without annotations

Type: transformation
\f[R]
.fi
.SH EXIT VALUES
.TP
.B \f[B]0\f[R]
Success
.TP
.B \f[B]not 0\f[R]
Failure
.SH SEE ALSO
.PP
\f[B]vcflib\f[R](1)
.SH OTHER
.SH LICENSE
.PP
Copyright 2011-2020 (C) Erik Garrison and vcflib contributors.
MIT licensed.
.SH AUTHORS
Erik Garrison and vcflib contributors.