File: vcfevenregions.md

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 (68 lines) | stat: -rw-r--r-- 1,551 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
% VCFEVENREGIONS(1) vcfevenregions (vcflib) | vcfevenregions (VCF transformation)
% Erik Garrison and vcflib contributors

# NAME

**vcfevenregions**

# SYNOPSIS

**vcfevenregions** [options] <vcf file>

# DESCRIPTION

Generates a list of regions, e.g. chr20:10..30 using the variant density information provided in the VCF file to ensure that the regions have even numbers of variants. This can be use to reduce the variance in runtime when dividing variant detection or genotyping by genomic coordinates.



# OPTIONS

```

options:
    -f, --fasta-reference REF    FASTA reference file to use to obtain primer sequences.
    -n, --number-of-regions N    The number of desired regions.
    -p, --number-of-positions N  The number of positions per region.
    -o, --offset N               Add an offset to region positioning, to avoid boundary
                                 related artifacts in downstream processing.
    -l, --overlap N              The number of sites to overlap between regions.  Default 0.
    -s, --separator SEQ          Specify string to use to separate region output.  Default '-'

Type: transformation

```





# EXIT VALUES

**0**
: Success

**not 0**
: Failure

# SEE ALSO



[vcflib](./vcflib.md)(1)



# OTHER

## Source code

[vcfevenregions.cpp](https://github.com/vcflib/vcflib/blob/master/src/vcfevenregions.cpp)

# LICENSE

Copyright 2011-2024 (C) Erik Garrison and vcflib contributors. MIT licensed.
Copyright 2020-2024 (C) Pjotr Prins.

<!--
  Created with ./scripts/bin2md.rb scripts/bin2md-template.erb
-->