number_of_low_pulses: Number of Low Flow Pulses

In mkoohafkan/flowregime: Environmental Flow Regime Indicators

Description

Compute the number of low flow pulses below a threshold.

Usage

number_of_low_pulses(ts, lt, min.dur = NA, ignore.first = FALSE,
  which = FALSE, return.which = c("first", "last", "min"))

Arguments

ts	A time series of class xts.
lt	The lower flow threshold below which to identify pulses.
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 pulses 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 minimum value ("min").

Value

The number of pulses below the threshold.

Examples

data(siouxcity)
number_of_low_pulses(siouxcity['2009'], lt = 12000)
number_of_low_pulses(siouxcity['2009'], lt = 12000, which = TRUE)

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