fh3: Function to return the FH3 hydrologic indicator statistic for...

Description Usage Arguments Value Examples

View source: R/standalone_scripts/stats_observed.r View source: R/standalone_scripts/stats_compare_wps.r View source: R/fh3.R View source: R/RProjects/HITHATStats/R/fh3.R

Description

This function accepts a data frame that contains a column named "discharge" and calculates FH3; High flood pulse count. Compute the average number of days per year that the flow is above a threshold equal to three times the median flow for the entire record. FH3 is the mean (or median-Use Preference option) of the annual number of days for all years (number of days/year-temporal).

Usage

1
  fh3(qfiletempf, pref = "mean")

Arguments

qfiletempf

data frame containing a "discharge" column containing daily flow values

pref

string containing a "mean" or "median" preference

Value

fh3 numeric value of FH3 for the given data frame

Examples

1
2

jlthomps/EflowStats documentation built on May 19, 2019, 12:48 p.m.