eventLimits: only tBeg and tEnd of events (possibly extended)

View source: R/eventMain.R

eventLimitsR Documentation

only tBeg and tEnd of events (possibly extended)

Description

return only the limits tBeg and tEnd of the event, possibly extended by a "context"

Usage

eventLimits(events, context = c(0, 0), absolute = FALSE)

Arguments

events

events as returned by e.g. toEvents

context

Vector of two elements giving the "context" before and after the event to be plotted, in percentage of event duration. e.g. c(0.1, 0.2) means that the time interval to be plotted starts 10 percent of the event duration before the event begin and ends 20 percent of the event duration after the end of the event.

absolute

if TRUE, the context values are interpreted as absolute values (seconds) instead of fractions of the event duration. Default: FALSE

Value

data frame with columns tBeg and tEnd, taken from events and possibly reduced (tBeg) and/or extended (tEnd) by a fraction of the event duration (read from column dur in events).


KWB-R/kwb.event documentation built on June 14, 2022, 1:15 p.m.