vcf_setregion {WhopGenome}R Documentation

Set region from which to return genome variation data.

Description

Set region from which to return genome variation data.

Usage

vcf_setregion( vcffh, tid, from=NA, to=NA )

Arguments

vcffh

VCF file handle

tid

Either a chromosome identifier (from and to MUST be specified) or a region string (rendering from and to unnecessary)

from

Start position of the region from which to return data, if str is a chromosome identifier

to

End position of the region from which to return data, if str is a chromosome identifier

Details

Parameter 'regionstr' is of the form "chr:beg-end", e.g. "1:102910-210030" for chromosome 1, positions >= 102910 and <= 210030. Use .Call("VCF_setRegion", vcffh, chromosomeid, from, to ) to eliminate the overhead of using the R wrapper function.

Value

TRUE or FALSE , whether the call succeeded or not.

Author(s)

Ulrich Wittelsbuerger

See Also

vcf_open vcf_getregion

Examples

	##
	##	Example:
	##
	vcffile <- vcf_open( system.file( "extdata" , "ex.vcf.gz" , package="WhopGenome" ) )
	
	vcf_setregion(vcffile, "Y", 1, 100000 )
	vcf_readLineVec( vcffile )

[Package WhopGenome version 0.9.7 Index]