.\" Automatically generated by Pandoc 2.7.3
.\"
.TH "VCFENTROPY" "1" "" "vcfentropy (vcflib)" "vcfentropy (VCF metrics)"
.hy
.SH NAME
.PP
\f[B]vcfentropy\f[R]
.SH SYNOPSIS
.PP
\f[B]vcfentropy\f[R] options
.SH DESCRIPTION
.PP
Annotate VCF records with the Shannon entropy of flanking sequence.
Anotates the output VCF file with, for each record, EntropyLeft,
EntropyRight, EntropyCenter, which are the entropies of the sequence of
the given window size to the left, right, and center of the record.
Also adds EntropyRef and EntropyAlt for each alt.
.SH OPTIONS
.IP
.nf
\f[C]

options:
    -f, --fasta-reference  FASTA reference file to use to obtain flanking sequences
    -w, --window-size      Size of the window over which to calculate entropy



Type: metrics
\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.