AHI: Calculate Aich's Hysteresis Index

Description Usage Arguments Value References Examples

View source: R/AHI.R

Description

This function calculates Hysteresis Index proposed by Aich et al. (2014)

Usage

1
AHI(dataframe, q, ssc, .warn = TRUE)

Arguments

dataframe

A data set object.

q

numeric, water discharge variable.

ssc

numeric, suspended sediment concentration variable.

.warn

logical, indicating if the warning message should be displayed.

Value

a numeric value either NA

References

Aich V, Zimmermann A, Elsenbeer H. 2014. Quantification and interpretation of suspended-sediment discharge hysteresis patterns: How much data do we need? CATENA 122: 120–129 DOI: 10.1016/j.catena.2014.06.020

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
library(dplyr)
data(djan)
output_table <- hydro_events(dataframe = djan,
                             q = discharge,
                             datetime = time,
                             window = 21)

output_table %>%
  filter(he == 2) %>%
  AHI(q = discharge, ssc = SS)

loadflux documentation built on Nov. 5, 2021, 5:07 p.m.