FlowScreen (version 1.2.6)

pks: Get the flow peaks over a threshold

Description

This function finds the flow peaks over a user defined threshold and declusters to remove dependent peaks.

Usage

pks(TS, Dur = 5, Qmax = 0.95)

Arguments

TS

output from create.ts containing a data.frame of flow time series

Dur

numeric value of the minimum number of days between peaks

Qmax

numeric value for peaks over threshold quantile. Default is 0.95.

Value

Returns a numeric vector of peaks of threshold values in m3/s. The "times" attribute contains the date by calendar year, and the "names" attribute contains the hydrologic year and hydrologic day of year, e.g., 2012 55.

Details

Peaks Over Threshold values are calcuated as mean daily streamflow (m3/s) minus the threshold streamflow value (m3/s) defined by the input quantile (Qmax). Peaks are identified with pot and the minimum inter-event duration (Dur) is applied by decluster.

Examples

# NOT RUN {
data(cania.sub.ts)
res <- pks(cania.sub.ts)
res2 <- screen.metric(res, "Peak Over Threshold (m3/s)")
# }