size.region: Get region size

In uclahs-cds/public-R-bedr: Genomic Region Processing using Tools Such as 'BEDTools', 'BEDOPS' and 'Tabix'

Get region size

Description

Get region size

Usage

size.region(
	x, 
	zero.based = TRUE, 
	check.zero.based = TRUE, 
	check.chr = TRUE, 
	check.valid = TRUE, 
	verbose = TRUE
	)

Arguments

x	region in vector, matrix or dataframe format
zero.based	whether the coordinates are zero-based or 1
check.zero.based	should 0 based coordinates be checked
check.chr	should chr prefix be checked
check.valid	should the region be checked for integerity
verbose	messages and checks

Value

size/length of the region

Author(s)

Daryl Waggott

See Also

convert2bed

Examples

if (check.binary("bedtools")) {

index <- get.example.regions();

a <- index[[1]];

a.sizes <- bedr:::size.region(a);
}

uclahs-cds/public-R-bedr documentation built on May 12, 2024, 3:56 p.m.