ffaframework (version 0.1.0)

plot_sffa_estimates: Plot Estimated Return Levels for S-FFA

Description

Generates a plot with return periods on the x-axis and return levels (annual maxima magnitudes) on the y-axis for S-FFA. The confidence bound is shown as a semi-transparent ribbon, and the point estimates are overlaid as a solid line. Return periods are shown on a logarithmic scale.

Usage

plot_sffa_estimates(results, periods = c(2, 5, 10, 20, 50, 100), ...)

Value

ggplot; a plot showing:

• A solid black line for the point estimates produced by the model.

• A semi-transparent gray ribbon indicating the confidence interval, if given.

Arguments

results

A fitted flood frequency model generated by fit_lmoments(), fit_mle() or fit_gmle() OR a fitted model with confidence intervals generated by uncertainty_bootstrap(), uncertainty_rfpl(), or uncertainty_rfgpl().

periods

Numeric vector used to set the return periods for FFA. All entries must be greater than or equal to 1.

...

Optional named arguments: 'title', 'xlabel', and 'ylabel'.

Examples

data <- rnorm(n = 100, mean = 100, sd = 10)
years <- seq(from = 1901, to = 2000)
results <- fit_lmoments(data, "WEI")
plot_sffa_estimates(results)