PlotFdcCompare: Plots a flow duration curve for up to three streamflow time...

Description Usage Arguments Details Value See Also Examples

View source: R/calculate_fdc.R

Description

PlotFdcCompare plots up to three flow duration curves for comparison.

Usage

1
2
3
4
PlotFdcCompare(strDf.obs, strCol.obs = "q_cms", strDf.mod1,
  strCol.mod1 = "q_cms", strDf.mod2 = NULL, strCol.mod2 = "q_cms",
  spline = TRUE, logy = TRUE, labelObs = "Observed",
  labelMod1 = "Model 1", labelMod2 = "Model 2")

Arguments

strDf.obs

The OBSERVED streamflow time series dataframe (e.g., output from ReadUsgsGage). The dataframe must contain a column of streamflow values and a POSIXct column.

strCol.obs

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

strDf.mod1

The FIRST MODEL streamflow time series dataframe (e.g., output from ReadFrxstPts). The dataframe must contain a column of streamflow values and a POSIXct column.

strCol.mod1

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

strDf.mod2

The SECOND MODEL streamflow time series dataframe (e.g., output from ReadFrxstPts). The dataframe must contain a column of streamflow values and a POSIXct column.

strCol.mod2

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

spline

(TRUE or FALSE) Option to add spline-fit curves to the plot (DEFAULT=TRUE).

logy

(TRUE or FALSE) Optional flag to set the y-axis to log-scale (DEFAULT=TRUE).

labelObs

Optional label for the observed streamflow (DEFAULT="Observed")

labelMod1

Optional label for the FIRST MODEL (DEFAULT="Model 1")

labelMod2

Optional label for the SECOND MODEL (DEFAULT="Model 2")

Details

PlotFdcCompare reads up to three dataframes (e.g., generated by ReadFrxstPts or ReadUsgsGage) and outputs a plot of flow vs. percent exceedances and, optionally, the fitted spline curves. Intended to plot one observed flow duration curve and one or two modelled flow duration curves for comparison. The tool will subset data to matching time periods (e.g., if the observed data is at 5-min increments and modelled data is at 1-hr increments, the tool will subset the observed data to select only observations on the matching hour break). Therefore, the tool will RECALCULATE the flow exceedance probabilities on the fly.

Value

A plot of flow (y) vs. flow exceedance probabilities (x).

See Also

Other flowDurationCurves: CalcFdcSpline, CalcFdc, PlotFdc

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
## Take a time series of observed 5-minute streamflow values for Fourmile
## Creek (obsStr5min.fc) and two hourly model runs (modStrh.allrt.fc, 
## modStrh.chrt.fc), all with streamflow columns named "q_cms", and plot 
## the flow duration curves for all three.


## Not run: 
PlotFdcCompare(obsStr5min.fc, "q_cms", modStrh.allrt.fc, "q_cms",
               strDf.mod2=modStrh.chrt.fc, strCol.mod2="q_cms", 
               labelObs="Observed Fourmile Creek", 
               labelMod1="All Routing", labelMod2="Channel Routing Only")

## End(Not run)

mccreigh/rwrfhydro documentation built on May 12, 2018, 3:08 a.m.