print.bage_mod: Printing a Model

In bage: Bayesian Estimation and Forecasting of Age-Specific Rates

Printing a Model

Description

After calling a function such as mod_pois() or set_prior() it is good practice to print the model object at the console, to check the model's structure. The output from print() has the following components:

• A header giving the class of the model and noting whether the model has been fitted.

• A formula giving the outcome variable and terms for the model.

• A table giving the number of parameters, and (fitted models only) the standard deviation across those parameters, a measure of the term's importance. See priors() and tidy().

• Values for other model settings. See set_disp(), set_var_age(), set_var_sexgender(), set_var_time(), set_n_draw()

• Details on computations (fitted models only). See computations().

Usage

## S3 method for class 'bage_mod'
print(x, ...)

Arguments

x	Object of class "bage_mod", typically created with mod_pois(), mod_binom(), or mod_norm().
...	Unused. Included for generic consistency only.

Value

x, invisibly.

See Also

• mod_pois(), mod_binom(), mod_norm() Model specification and class

• fit.bage_mod() and is_fitted() Model fitting

• priors Overview of priors for model terms

• tidy.bage_mod() Number of parameters, and standard deviations

• set_disp() Dispersion

• set_var_age(), set_var_sexgender(), set_var_time() Age, sex/gender and time variables

• set_n_draw() Model draws

Examples

mod <- mod_pois(injuries ~ age + sex + year,
                data = nzl_injuries,
                exposure = popn)

## print unfitted model
mod

mod <- fit(mod)

## print fitted model
mod

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