discharge (version 1.0.0)

residplot.extreme: Plot annual extreme residuals

Description

Creates a plot with the maximum annual low- and high residuals for each year in the series.

Usage

residplot.extreme(x, text=FALSE, data=FALSE)

Arguments

x

Object of class streamflow.

text

Logical. If true, points corresponding to flows greater than \(2\sigma\) are labeled on the plot.

data

Logical. If true, the extreme residuals are returned in the output.

Value

Plot with year on the x-axis and the maximum residual magnitude for that year on the y-axis.

If data=TRUE, output includes a list with the following components:

annual.max

Matrix with data corresponding to the maximum residual flow for each year in series.

annual.min

Matrix with data corresponding to the minimum residual flow for each year in series.

See Also

sigmaHighFlows sigmaLowFlows

Examples

# NOT RUN {
# load data
data(sycamore)

# plot
residplot.extreme(asStreamflow(sycamore))
# }