event_coverage: Event Coverage

View source: R/event_metrics.R

event_coverageR Documentation

Event Coverage

Description

Returns the intervals over which the number of events is always one or greater.

Usage

event_coverage(e, closed = TRUE)

Arguments

e

An event table.

closed

Logical value indicating whether events should be interpreted as closed intervals. If TRUE, coverage is continuous at breaks between two adjacent events.

Details

If closed = TRUE, breaks between adjacent events are dropped. If closed = FALSE, breaks between adjacent events are retained, including point events on line event endpoints. Duplicate points are dropped in both cases.

See Also

event_gaps for gaps (the inverse of coverage), event_range for range (coverage with gaps ignored).

Examples

e <- events(c(1, 2, 4, 8), c(3, 4, 5, 10))
event_coverage(e, closed = TRUE)  # retains breaks
event_coverage(e, closed = FALSE) # drops breaks
e <- events(c(0, 2, 2, 2, 8, 10), c(0, 2, 2, 6, 10, 10))
event_coverage(e, closed = TRUE)  # retains isolated points
event_coverage(e, closed = FALSE) # retains isolated points and points adjacent to lines

ezwelty/linbin documentation built on April 19, 2023, 8:41 a.m.