unfit: Unfit a Model

View source: R/bage_mod-functions.R

unfitR Documentation

Unfit a Model

Description

Reset a model, deleting all estimates.

Usage

unfit(mod)

Arguments

mod

A fitted object of class "bage_mod", object, created through a call to mod_pois(), mod_binom(), or mod_norm().

Value

An unfitted version of mod.

See Also

  • fit() Fit a model

  • mod_pois(), mod_binom(), mod_norm() Specify a model

  • Functions such as set_prior(), set_disp() and set_var_age() unfit models as side effects.

Examples

## create a model, which starts out unfitted
mod <- mod_pois(injuries ~ age + sex + year,
                data = nzl_injuries,
                exposure = popn)
is_fitted(mod)

## calling 'fit' produces a fitted version
mod <- fit(mod)
is_fitted(mod)

## calling 'unfit' resets the model
mod <- unfit(mod)
is_fitted(mod)

bage documentation built on April 3, 2025, 8:53 p.m.