number_of_high_pulses: Number of High Flow Pulses

In mkoohafkan/flowregime: Environmental Flow Regime Indicators

Description

Compute the number of high flow pulses (peaks) above a threshold.

Usage

number_of_high_pulses(ts, ut, min.dur = NA, ignore.first = FALSE,
  which = FALSE, return.which = c("first", "last", "max"))

Arguments

ts	A time series of class xts.
ut	The upper flow threshold above which to identify peaks.
min.dur	The minimum duration required for a pulse to be counted.
ignore.first	Logical: Ignore the first pulse if it occurs at the start of record.
which	Logical: If TRUE, return the index locations of the peaks instead of the count.
return.which	For each pulse, return the index corresponding to the start of the pulse ("first"), end of the pulse ("last"), or occurrence of the maximum value ("max").

Value

The number of peaks above the threshold.

Examples

data(siouxcity)
number_of_high_pulses(siouxcity['2009'], ut = 32000)
number_of_high_pulses(siouxcity['2009'], ut = 32000, which = TRUE)

mkoohafkan/flowregime documentation built on May 23, 2019, 2:02 a.m.