Get Events with Statistics

Get Events with Statistics

Usage

getEventsWithStatistics(
  rainData,
  seriesName,
  eventSeparationTime,
  signalThreshold = 0,
  signalComparisonOperator = "gt",
  eventSeparationOperator = "gt",
  functions = c("sum", "mean", "min", "max", "number.na", "length"),
  signalWidth = NA
)

Arguments

rainData

data frame with time stamps in the first column and rain heights (or intensities) in the remaining columns

seriesName

Column name in rainData representing the time series to be analysed.

eventSeparationTime

passed to getEvents

signalThreshold

value that needs to be exceeded (signalComparisonOperator == "gt") or reached (signalComparisonOperator == "ge") by the rain heights (or intensities) in order to be counted as a "signal". Default: 0

signalComparisonOperator

Operator to be applied when comparing rain values with signalThreshold. Must be one of "gt" (greater than) or "ge" greater than or equal. Default: "gt"

eventSeparationOperator

passed to getEvents

functions

passed to getEventStatistics

signalWidth

passed to getEvents