rvn_fdc_plot: Plots summary of watershed forcing functions

View source: R/rvn_fdc_plot.R

rvn_fdc_plotR Documentation

Plots summary of watershed forcing functions

Description

rvn_fdc_plot generation a flow duration curve plot.

Usage

rvn_fdc_plot(sim = NULL, obs = NULL, prd = NULL, seasonal = FALSE)

Arguments

sim

simulated hydrograph xts time series

obs

(optional) observed hydrograph xts time series

prd

(optional) time period over which the plot is generated

seasonal

(optional) boolean whether to add the winter and summer FDC

Details

Creates a flow duration curve using the rvn_hyd_extract obejct for a given basin. The hydrograph object passed should be the output from the rvn_hyd_extract function, which has attributes for sim and obs; if the obs is NULL, only the sim FDC will be plotted.

If the seasonal argument is included, the winter and summer FDC lines will be included on the plot as well.

See Also

rvn_hyd_read for reading in the Hydrographs.csv file, and rvn_hyd_extract for extracting basin flow information from a rvn_hyd_read object

Examples


# load sample hydrograph data, two years worth of sim/obs
ff <- system.file("extdata/run1_Hydrographs.csv", package="RavenR")
run1 <- rvn_hyd_read(ff)
sim <- run1$hyd$Sub36
obs <- run1$hyd$Sub36_obs

# create FDC plot, sim only
rvn_fdc_plot(sim)

 # create seasonal FDC plot with sim and obs data
rvn_fdc_plot(sim,obs,seasonal=TRUE)


rchlumsk/RavenR documentation built on April 19, 2024, 5:15 a.m.