Skip to contents

Bulletin 17C distribution model

Source: R/model.R
model_bulletin17c.Rd

The log-Pearson Type III flood-frequency model of Bulletin 17C, fit by the generalized method of moments. Handles the censored observation types directly, which is the point of using it over a plain model_univariate().

Usage

model_bulletin17c(
  data,
  family = "LogPearsonTypeIII",
  parameters = NULL,
  parameter_values = NULL
)

Arguments

data

a numeric vector of annual peaks, or an analysis_data() frame.

family

the distribution family; one of "LogPearsonTypeIII" (the default), "Exponential", "Gamma", "LogNormal", "Normal", or "PearsonTypeIII".

parameters

optional model_parameter() object or list of them, setting bounds, fixed flags, priors, or starting values.

parameter_values

optional numeric vector of all parameter values, applied last.

Value

An object of class corehydro_model.

See also

bulletin17c_analysis().

Examples

peaks <- c(12500, 15300, 8900, 22100, 18700, 14200, 9800, 28500, 17400, 11600,
           19200, 13800, 25600, 10500, 16900)
model_bulletin17c(analysis_data(peaks, mgbt_low_outliers = TRUE))
#> <corehydro_model> bulletin17c: LogPearsonTypeIII
#>   data: <corehydro_data> 15 exact
#>   low outliers: from the Multiple Grubbs-Beck test