eventBaseflow: Event identification (using baseflow index)

View source: R/eventBaseflow.R

eventBaseflowR Documentation

Event identification (using baseflow index)

Description

Events are identified on the basis of the Baseflow Index (BFI).

Usage

eventBaseflow(
  data,
  BFI_Th = 0.5,
  bfi = baseflowB(data)$bfi,
  min.diff = 1,
  out.style = "summary"
)

Arguments

data

The data vector (e.g. a streamflow time series)

BFI_Th

Minimum BFI to identify baseflow

bfi

If no BFI is provided the BFI is calculated automatically using baseflowB

min.diff

Minimum length for an event

out.style

The type of output (currently either "summary" or "none")

Details

Any flow above the BFI_Th will be considered an event with a minimum event separation of min.diff.

Value

By default, the out.style returns the indices of the maximum in each event, as well as the value of the maximum and the sum of the data in each event, alongside the start and end of the events. Otherwise just the indices of start and end of events as a two column dataframe are returned.

References

Kaur, S., Horne, A., Stewardson, M.J., Nathan, R., Costa, A.M., Szemis, J.M., & Webb, J.A., (2017) Challenges for determining frequency of high flow spells for varying thresholds in environmental flows programmes. J. Ecohydraulics 2, 28–37.

See Also

calcStats eventBaseflow eventMaxima eventPOT

Examples

# Example
BFI_res = eventBaseflow(dataBassRiver, BFI_Th = 0.5, min.diff = 1)

hydroEvents documentation built on Dec. 28, 2022, 3:06 a.m.