-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathhelp.html
93 lines (75 loc) · 3.12 KB
/
help.html
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
81
82
83
84
85
86
87
88
89
90
91
92
93
<html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>vcf.iobio.io help</title>
<link href='assets/css/quicksand.css' rel='stylesheet' type='text/css'>
<link href='https://fonts.googleapis.com/css?family=Muli' rel='stylesheet' type='text/css'>
<link href="assets/css/iobio.css" rel="stylesheet" type='text/css'>
<link href='https://fonts.googleapis.com/css?family=Open+Sans' rel='stylesheet' type='text/css'>
<style>
header {
font-family: Quicksand;
}
h1, h2, h3, h4 {
font-family: Muli;
}
h1 {
font-size: 26px;
font-weight: normal;
}
h2 {
font-size: 24px;
}
h3 {
font-size: 18px;
margin-top: 40px;
}
h4 {
margin-bottom: 5px;
}
body {
margin: 20px;
font-family: Open Sans;
width: 900px;
font-weight: 300;
}
</style>
</head>
<body>
<header><a href="http://vcf.iobio.io">vcf<span style="color:rgb(200,200,200)">.iobio.io</span><span color> </a></header>
<h1>The compressed and indexed VCF</h1>
Compressing VCF files with BGZip and indexing it with Tabix is the standard way VCF files are stored, and is the format that vcf.iobio.io supports. The software to compress and index VCF files is called Tabix, developed by Heng Li at the Broad Institute. The source code is available on SourceForge and can be obtained at: <a href="http://sourceforge.net/projects/samtools/files/tabix/">http://sourceforge.net/projects/samtools/files/tabix/</a>
<h3>Compiling Tabix</h3>
<h4>Linux</h4>
Install C compiler and the 'make' utility with the package management system of your specific Linux distribution. In the case of Ubuntu, the following command should suffice:
<pre>
$ sudo apt-get install build-essential
$ tar -xjf tabix-0.2.6.tar.bz2
$ cd tabix-0.2.6
$ make
</pre>
<h4>Mac OS X</h4>
We provide the precompiled static binaries of bgzip and Tabix, as well as a simple GUI application for Mac users, all of which can be downloaded here:
<p>
<a href="tabix/iTabixit.zip">iTabixit GUI</a>
<p>
<a href="tabix/TabixBinary.zip">Tabix and BGZip binaries</a>
<p>
The compiler toolchain is contained in Xcode, Apple's free software development platform. After installing Xcode from the Mac App Store, Tabix can be compiled as follows:
<pre>
$ tar -xjf tabix-0.2.6.tar.bz2
$ cd tabix-0.2.6
$ make
</pre>
<h3>Compressing and Indexing your VCF</h3>
Once you have successfully compiled Tabix (and bgzip), you can compress your vcf files with the following command:
<pre>
$ /path/to/tabix/bgzip myvcf.vcf
$ /path/to/tabix/tabix -p vcf myvcf.vcf.gz
</pre>
These two commands will create two new files: the compressed vcf (.vcf.gz) and the index (.vcf.gz.tbi). Now you are ready to run <a href="index.html">vcf.iobio</a>, selecting these two files when prompted.
<p>
The manual page for Tabix and BGZip can be found at <a href="http://samtools.sourceforge.net/tabix.shtml">http://samtools.sourceforge.net/tabix.shtml</a>
</body>
</html>