File: README.md

package info (click to toggle)
vcftools 0.1.14+dfsg-4+deb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 1,908 kB
  • sloc: cpp: 13,928; perl: 11,080; ansic: 1,467; sh: 135; makefile: 100
file content (80 lines) | stat: -rw-r--r-- 1,929 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
74
75
76
77
78
79
80
# VCFtools

A set of tools written in Perl and C++ for working with [VCF files](https://samtools.github.io/hts-specs/VCFv4.2.pdf), such as those generated by the
[1000 Genomes Project](http://www.1000genomes.org/).

Project website: https://vcftools.github.io/

License
-------

The program package is released under the GNU Lesser General Public License version 3.0
(LGPLv3). See the `LICENSE` file for the complete LGPL license text.

Credits
-------

- Adam Auton (Binary Executable)
- Petr Danecek (Perl Module)
- Anthony Marcketta (Binary Executable)

Building VCFtools
-----------------

General help about the building process's configuration step can be acquired via:

```
./configure --help
```

### Build from Release Tarball

```
./configure
make
make install
```
You many need `sudo` permissions to run `make install`.

### Build from GitHub

```
git clone https://github.com/vcftools/vcftools.git
cd vcftools
./autogen.sh
./configure
make
make install
```
You many need `sudo` permissions to run `make install`.

Documentation
-------------

Documentation and usage examples can be found here:

https://vcftools.github.io/examples.html

A manual page is also available. If prefix is set to `/usr` or if `MANPATH` points to
`$prefix/share/man`, you can access the manual page via:

```
man vcftools
```

Getting Help
------------

The best way to get help regarding VCFtools is to email the mailing list:

vcftools-help@lists.sourceforge.net

Citation
--------

If you make use of VCFtools in your research, we would appreciate a citation of the following paper:

> **The Variant Call Format and VCFtools**, Petr Danecek, Adam Auton, Goncalo Abecasis, Cornelis
> A. Albers, Eric Banks, Mark A. DePristo, Robert Handsaker, Gerton Lunter, Gabor Marth, Stephen
> T. Sherry, Gilean McVean, Richard Durbin and 1000 Genomes Project Analysis Group,
> **Bioinformatics**, 2011 http://dx.doi.org/10.1093/bioinformatics/btr330