DesHydro {UKFE} | R Documentation |
Design hydrograph extraction
Description
Extracts a mean hydrograph from a flow series
Usage
DesHydro(
x,
div,
EventSep,
N = 10,
Exclude = NULL,
Plot = TRUE,
main = "Design Hydrograph"
)
Arguments
x |
a dataframe with Date or POSIXct in the first coumn and the numeric vector of discharge in the second |
div |
The number of timesteps to separate peaks for the peak extraction process. |
EventSep |
When hydrographs are extracted according to the peaks, the start and end point of the hydrograph is Peak - EventSep and Peak + EventSep * 1.5 |
N |
number of event hydrographs from which to derive the mean hydrograph. Default is 10. Depending on the length of x, there may be fewer than 10 |
Exclude |
An index (single integer or vector of integers up to N) for which hydrographs to exclude if you so wish. This may require some trial and error. You may want to increase N for every excluded hydrograph. |
Plot |
logical argument with a default of TRUE. If TRUE, all the hydrographs from which the mean is derived are plotted along with the mean hydrograph. |
main |
Title for the plot |
Details
All the peaks over the 97.5th percentile are identified and separated by a user defined value 'div', which is a number of time steps. The top N peaks are selected and the hydrographs extracted where EventSep is the number of timesteps either side of the peak. Each hydrograph is centred on the peak and truncated either side by EventSep. All events are scaled to have a peak flow of one, and the mean of these is taken as the scaled design hydrograph.
Value
a list of length three. The first element is a dataframe of the peaks of the hydrographs and the associated dates. The second element is a dataframe with all the scaled hydrographs, each column being a hydrograph. The third element is the averaged hydrograph
Author(s)
Anthony Hammond
Examples
#Extract a design hydrograph from the Thames daily mean flow. Then print the resulting hydrograph
ThamesDesHydro <- DesHydro(ThamesPQ[,c(1,3)], div = 30, EventSep = 10, N = 10)