vcf_eor: Determine whether all lines in the selected region have been...

Description Usage Arguments Details Value Author(s) Examples

View source: R/regions.R

Description

When reading SNP info within a region defined by VCF_setRegion, this function returns TRUE/FALSE to indicate whether or not all lines within that region have been read.

Usage

1
vcf_eor( vcffh )

Arguments

vcffh

Handle of a VCF file opened by VCF_open

Details

Use .Call("VCF_eor", vcffh ) to eliminate the overhead of using the R wrapper function.

Value

TRUE if all SNPs inside the previously defined region have been read.

Author(s)

Ulrich Wittelsbuerger

Examples

1
2
3
4
5
6
	vcffile <- vcf_open( system.file( "extdata", "ex.vcf.gz" , package="WhopGenome") )
	vcf_setregion(vcffile, "Y", 1, 100000 )
	while( !vcf_eor(vcffile) )
	{
		vcf_readLineVec( vcffile )
	}

WhopGenome documentation built on May 1, 2019, 10:12 p.m.