Build Tabix-index required for processing VCF files.

Description

Builds a Tabix-index for a VCF file that is already sorted and compressed.

Usage

vcf_buildindex( filename )

Arguments

Details

Given the name of a VCF file, builds a Tabix-index file (automatically named <filename>.tbi) in the directory where the given VCF file is located. Prerequisite is that the VCF file be sorted by chromosome and position as well as bgzip-compressed. Such files carry the extension .vcf.gz. Information on how to sort data in VCF files can be found at < http://vcftools.sourceforge.net/docs.html >. Using bgzf_compress, you can thereafter compress the file.

Value

Returns TRUE if the index could be created or FALSE if not.

Author(s)

Ulrich Wittelsbuerger

See Also

tabix_build bgzf_compress

Examples

	##
	##	Example:
	##

Results