summarise_central_estimate: Summarise central estimate

In serofoi: Bayesian Estimation of the Force of Infection from Serological Data

Summarise central estimate

Description

Summarise central estimate

Usage

summarise_central_estimate(
  seromodel,
  serosurvey,
  alpha,
  par_name = "seroreversion_rate",
  central_estimate_digits = 2
)

Arguments

seromodel	stan_fit object obtained from sampling a model with fit_seromodel
serosurvey	survey_year Year in which the survey took place (only needed to plot time models) age_min Floor value of the average between age_min and age_max age_max The size of the sample n_sample Number of samples for each age group n_seropositive Number of positive samples for each age group
alpha	1 - alpha indicates the credibility level to be used
par_name	String specifying the parameter to be extracted from seromodel
central_estimate_digits	Number of central estimate digits

Value

Text summarising specified central estimate

Examples

data(veev2012)
seromodel <- fit_seromodel(veev2012, iter = 100)
summarise_central_estimate(
  seromodel,
  veev2012,
  alpha = 0.05,
  par_name = "foi"
  )

serofoi documentation built on April 3, 2025, 11:40 p.m.