report_sim: Simulation Study of a Model

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

Simulation Study of a Model

Description

Use simulated data to assess the performance of an estimation model.

Usage

report_sim(
  mod_est,
  mod_sim = NULL,
  method = c("standard", "inner-outer"),
  vars_inner = NULL,
  n_sim = 100,
  point_est_fun = c("median", "mean"),
  widths = c(0.5, 0.95),
  report_type = c("short", "long", "full"),
  n_core = 1
)

Arguments

mod_est	The model whose performance is being assessed. An object of class bage_mod.
mod_sim	The model used to generate the simulated data. If no value is supplied, mod_est is used.
method	Estimation method used for mod_est. See fit().
vars_inner	Variables used in inner model with "inner-outer"estimation method. See fit().
n_sim	Number of sets of simulated data to use. Default is 100.
point_est_fun	Name of the function to use to calculate point estimates. The options are "mean" and "median". The default is "mean".
widths	Widths of credible intervals. A vector of values in the interval ⁠(0, 1]⁠. Default is c(0.5, 0.95).
report_type	Amount of detail in return value. Options are "short" and "long". Default is "short".
n_core	Number of cores to use for parallel processing. If n_core is 1 (the default), no parallel processing is done.

Value

A named list with a tibble called "components" and a tibble called "augment".

Warning

The interface for report_sim() is still under development and may change in future.

See Also

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

• components(), augment() Draw from joint prior or posterior distribution of model

• replicate_data() Generate replicate data for a model

Examples

## results random, so set seed
set.seed(0)

## make data - outcome variable (deaths here)
## needs to be present, but is not used
data <- data.frame(region = c("A", "B", "C", "D", "E"),
                   population = c(100, 200, 300, 400, 500),
                   deaths = NA)

## simulation with estimation model same as
## data-generating model
mod_est <- mod_pois(deaths ~ region,
                    data = data,
                    exposure = population) |>
  set_prior(`(Intercept)` ~ Known(0))
report_sim(mod_est = mod_est,
           n_sim = 10) ## in practice should use larger value

## simulation with estimation model different
## from data-generating model
mod_sim <- mod_est |>
  set_prior(region ~ N(s = 2))
report_sim(mod_est = mod_est,
           mod_sim = mod_sim,
           n_sim = 10)

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