calculate_summaries: Calculate summaries of weighted statistics

In AMISforInfectiousDiseases: Implement the AMIS Algorithm for Infectious Disease Models

Calculate summaries of weighted statistics

Description

Calculate summaries of weighted statistics

Usage

calculate_summaries(
  x,
  what = "prev",
  time = 1,
  locations = NULL,
  alpha = 0.05,
  exceedance_prob_threshold = 0.35
)

Arguments

x	The output from the function amis().
what	What statistic should be calculated the summaries from. It must be either "prev" or the name of one of the model parameters. Default to "prev".
time	Time point. Only used if "what" is set to "prev".
locations	Integer vector or location names identifying locations where summaries should be calculated for. If not specified, summary statistics of all locations will be provided.
alpha	Numeric value between 0 and 1. Calculations are for the (alpha/2, 1-alpha/2)% quantiles.
exceedance_prob_threshold	Numeric value. Default to 0.35, i.e. the probability that the statistic of interest (e.g. prevalence) is higher than 0.35.

Details

For illustrative examples, see amis().

Value

A list with mean, median, and quantiles of the weighted distribution.

AMISforInfectiousDiseases documentation built on April 4, 2025, 1:45 a.m.