extract.runoff: Extract runoff events

In codyalbertross/HydRun: R implementation of the MATLAB toolbox HydRun

Description

Extracts runoff events from a stormflow timeseries.

Usage

extract.runoff(
  stormflow,
  min_diff,
  return_ratio,
  b_slope,
  e_slope,
  sc,
  min_dur,
  dyslp
)

Arguments

stormflow	A stream stormflow data frame (format is 2 columns: datetime and stormflow).
min_diff	The minimum difference between the start (or end) of runoff and the runoff peak.
return_ratio	Determines where runoff terminates: runoff is terminated when it declines below a dynamic threshold (peak discharge)*return_ratio.
b_slope	The beginning slope (slope threshold used to cut flat head).
e_slope	The ending slope (slope threshold to end event).
sc	The smoothing coefficient, which determines the number of passes applied to stormflow.
min_dur	The minimum duration of a runoff event, expressed as the number of timesteps.
dyslp	The dynamic slope threshold used to cut the flat head and end the runoff event.

Value

A list containing the runoff events, RunoffEvents, and the number of runoff events, nRunoffEvent.

Note

This is an R implementation of a function from the MATLAB toolbox HydRun.

References

Tang, W., & Carey, S. K. (2017). HydRun: a MATLAB toolbox for rainfall runoff analysis. Hydrological Processes, 31(15), 2670-2682.

Examples

runoff_events <- extract.runoff(stormflow, 1.1, 0.001, 0.001, 0.35, 1, 4, 0.001)

codyalbertross/HydRun documentation built on Dec. 19, 2021, 5:21 p.m.