filterEventsWithStatistics: Filter Events with Statistics

View source: R/eventHighLevel.R

filterEventsWithStatisticsR Documentation

Filter Events with Statistics

Description

Filter Events with Statistics

Usage

filterEventsWithStatistics(
  eventData,
  durationThreshold = 0,
  durationComparisonOperator = "gt",
  sumThreshold = 0,
  sumComparisonOperator = "gt"
)

Arguments

eventData

eventData of one time series, as returned in one list element by getEventsWithStatistics.

durationThreshold

duration in seconds that needs to be exceeded (durationComparisonOperator == "gt") or reached (durationComparisonOperator == "ge") by the duration of the rain events. Default: 0

durationComparisonOperator

Operator to be applied when comparing the duration of the events with durationThreshold. Must be one of "gt" (greater than) or "ge" greater than or equal. Default: "gt"

sumThreshold

value that needs to be exceeded (sumComparisonOperator == "gt") or reached (sumComparisonOperator == "ge") by the 'sum' of values within the events. Default: 0

sumComparisonOperator

Operator to be applied when comparing the 'sum' of values within the events with sumThreshold. Must be one of "gt" (greater than) or "ge" greater than or equal. Default: "gt"


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