calculate_exceedances: Calculate exceedance levels

Description Usage Arguments Value

View source: R/calculate_exceedances.R

Description

Given a data frame with a "lake" and "level" column, calculates levels associated with desired exceedance probabilities.

Usage

1
2
3
4
5
6
calculate_exceedances(
  df,
  probs = c(10, 25, 50, 75, 90),
  departures = NULL,
  melted = TRUE
)

Arguments

df

a data frame with a "lake" and a "level" column

probs

a vector with all exceedance probabilities to calculate. Defaults to c(10, 25, 50, 75, 90)

departures

optional vector with departures from median to evaluate probability of occurrence. Defaults to NULL to trigger exceedance probability calculations instead.

melted

logical defaults to true to indicate should melt data frame to just 3 columns (lake, variable, value). Otherwise, keeps as data frame with one column per exceedance probability.

Value

exceeds, a data frame with the names of all lakes and corresponding exceedance levels


WDNR-Water-Use/CSLSlevels documentation built on Nov. 21, 2020, 9:13 a.m.