kit_summary_table: Summarize model fit

View source: R/utils-table.R

kit_summary_tableR Documentation

Summarize model fit

Description

Provides a summary of:

  • Estimated kits distributed

  • Percentage of kits distributed that are reported

  • Estimated kits used

  • percentage of kits used that are reported

  • percentage of kits orders that are used

  • probability kit used if distributed

Usage

kit_summary_table(fit, ..., data = NULL, accuracy = 0.01, cri_range = 0.95)

Arguments

fit

stanfit object

...

variables to group by in estimate

data

data used for model fitting. Can also include p_use column which can be used to plot true values if derived from simulated data.

accuracy

A number to round to. Use (e.g.) 0.01 to show 2 decimal places of precision. If NULL, the default, uses a heuristic that should ensure breaks have the minimum number of digits needed to show the difference between adjacent values.

cri_range

The range of the credible interval e.g. 0.95

Value

A tibble::tibble

  • Probability of kit use if distributed

  • Estimated as distributed

  • Proportion kits distributed that are reported

  • Estimated kits used

  • Proportion kits used that are reported

  • Proportion kits ordered that are used

See Also

Other plots: plot_kit_use()

Examples

## Not run: 
  fit <- est_naloxone(d)
  kit_summary_table(fit,regions,data = d)

## End(Not run)

bennu documentation built on Sept. 14, 2023, 1:08 a.m.