CalcFdc: Calculate flow duration curve statistics

Description Usage Arguments Details Value See Also Examples

View source: R/calculate_fdc.R

Description

CalcFdc calculates flow exceedance probabilities and adds them as a new column to the dataframe.

Usage

1
CalcFdc(strDf, strCol = "q_cms")

Arguments

strDf

The streamflow time series dataframe (e.g., output from ReadFrxstPts or ReadUsgsGage). The data frame must contain a column of streamflow values.

strCol

The name of the column containing the streamflow values (DEFAULT="q_cms").

Details

CalcFdc reads a streamflow time series dataframe (modeled or observed) and outputs a modified dataframe with calculated percent exceedances.

Value

A dataframe containing the original input data with a new column added called "<strCol>.fdc" containing the flow exceedance probabilities.

See Also

Other flowDurationCurves: CalcFdcSpline, PlotFdcCompare, PlotFdc

Examples

1
2
3
4
5
6
7
8
## Take the time series of observed 5-minute streamflow values for Fourmile 
## Creek (stored in the dataframe obsStr5min.fc in the column "q_cms") and 
## return the same dataframe with a new column called "q_cms.fdc"
## containing the flow exceedance probabilities.
## Not run: 
obsStr5min.fc <- CalcFdc(obsStr5min.fc, "q_cms")

## End(Not run)

NCAR/rwrfhydro documentation built on Feb. 28, 2021, 12:47 p.m.