distribution_fit {tidyindex}

The distribution fit module

Description

This module fits a distribution to the variable of interest. Currently implemented distributions are: gamma, dist_gamma(), generalized logistic, dist_glo(), generalized extreme value, dist_gev(), and Pearson Type III, dist_pe3()

Usage

distribution_fit(data, ...)

dist_gamma(var, method = "lmoms", .n_boot = 1, .boot_seed = 123)

dist_glo(var, method = "lmoms", .n_boot = 1, .boot_seed = 123)

dist_gev(var, method = "lmoms", .n_boot = 1, .boot_seed = 123)

dist_pe3(var, method = "lmoms", .n_boot = 1, .boot_seed = 123)

Arguments

data

an index table object

...

a distribution fit object, currently implemented are dist_gamma(), dist_glo(), dist_gev(), and dist_pe3()

var

used in dist_*() functions, the variable to fit

method

used in dist_*() functions, the fitting method, currently support "lmoms" for L-moment fit

.n_boot

the number of bootstrap replicate, default to 1

.boot_seed

the seed to generate bootstrap replicate, default to 123

Value

an index table object

Examples

library(dplyr)
library(lmomco)
tenterfield |>
  mutate(month = lubridate::month(ym)) |>
  init(id = id, time = ym, group = month) |>
  temporal_aggregate(.agg = temporal_rolling_window(prcp, scale = 12)) |>
  distribution_fit(.fit = dist_gamma(.agg, method = "lmoms"))