addEventLines: add lines to dygrap plot representing begin and end of events

In KWB-R/kwb.dygraph: Additional Functions to be Used with dygraph-Objects

add lines to dygrap plot representing begin and end of events

Description

add lines to dygrap plot representing begin and end of events

Usage

addEventLines(
  dygraph,
  events,
  labels = seq_len(nrow(events)),
  color = "red",
  labelLoc = "top",
  color.begin = color,
  color.end = color,
  labelLoc.begin = labelLoc,
  labelLoc.end = labelLoc,
  signalWidth = kwb.event::hsSigWidth(events)
)

Arguments

dygraph	dygraph object as returned by dygraph
events	data frame with columns tBeg (begin time) and tEnd (end time) of events to be drawn
labels	labels given to the events (default: 1:nrow(events))
color	color (default: "red")
labelLoc	"top" or "bottom" (default: "top")
color.begin	default: same as argument "color"
color.end	default: same as argument "color"
labelLoc.begin	default: same as argument "labelLoc"
labelLoc.end	default: same as argument "labelLoc"
signalWidth	signal width in seconds = length of time interval that one timestamp in the original data represents, e.g. 300 for 5-minutes-data.

Value

modified dygraph object

KWB-R/kwb.dygraph documentation built on June 15, 2022, 12:38 a.m.