File: hapLrt.1

package info (click to toggle)
libvcflib 1.0.12%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 70,520 kB
  • sloc: cpp: 39,837; python: 532; perl: 474; ansic: 317; ruby: 295; sh: 254; lisp: 148; makefile: 123; javascript: 94
file content (73 lines) | stat: -rw-r--r-- 2,081 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
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
.\" Automatically generated by Pandoc 2.19.2
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "HAPLRT" "1" "" "hapLrt (vcflib)" "hapLrt (VCF genotype)"
.hy
.SH NAME
.PP
\f[B]hapLrt\f[R]
.SH SYNOPSIS
.PP
hapLRT \[en]target 0,1,2,3,4,5,6,7 \[en]background 11,12,13,16,17,19,22
\[en]type GP \[en]file my.vcf
.SH DESCRIPTION
.PP
HapLRT is a likelihood ratio test for haplotype lengths.
The lengths are modeled with an exponential distribution.
The sign denotes if the target has longer haplotypes (1) or the
background (-1).
.SH OPTIONS
.IP
.nf
\f[C]


Output : 4 columns :                             
     1. seqid                                    
     2. position                                 
     3. mean target haplotype length             
     4. mean background haplotype length         
     5. p-value from LRT                         
     6. sign                                     

required: t,target     -- argument: a zero base comma separated list of target individuals corresponding to VCF columns        
required: b,background -- argument: a zero base comma separated list of background individuals corresponding to VCF columns    
required: f,file       -- argument: a properly formatted phased VCF file                                                       
required: y,type       -- argument: type of genotype likelihood: PL, GL, GT or GP                                                  
optional: r,region     -- argument: a genomic range to calculate **hapLrt** on in the format : \[dq]seqid:start-end\[dq] or \[dq]seqid\[dq] 


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