File: pVst.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 (64 lines) | stat: -rw-r--r-- 1,793 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
.\" Automatically generated by Pandoc 2.7.3
.\"
.TH "PVST" "1" "" "pVst (vcflib)" "pVst (VCF statistics)"
.hy
.SH NAME
.PP
\f[B]pVst\f[R]
.SH SYNOPSIS
.PP
\f[B]pVst\f[R] \[en]target 0,1,2,3,4,5,6,7 \[en]background
11,12,13,16,17,19,22 \[en]file my.vcf \[en]type CN
.SH DESCRIPTION
.PP
\f[B]pVst\f[R] calculates vst, a measure of CNV stratification.
.SH OPTIONS
.IP
.nf
\f[C]




The statistic Vst is used to test the difference in copy numbers at
each SV between two groups: Vst = (Vt-Vs)/Vt, where Vt is the overall
variance of copy number and Vs the average variance within
populations.

Output : 4 columns :     
     1. seqid            
     2. position         
     3. end              
     3. vst              
     4. probability      

required: t,target     -- argument: a zero based comma separated list of target individuals corresponding to VCF columns       
required: b,background -- argument: a zero based comma separated list of background individuals corresponding to VCF columns   
required: f,file       -- argument: a properly formatted VCF.                                                                  
required: y,type       -- argument: the genotype field with the copy number: e.g. CN|CNF                           
optional: r,region     -- argument: a tabix compliant genomic range : seqid or seqid:start-end                                 
optional: x,cpu        -- argument: number of CPUs [1] 
optional: n,per        -- argument: number of permutations [1000] 

Type: statistics


\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.