extract_stan_param: Extract a Parameter Summary from a Stan Object

In epiforecasts/EpiNow2: Estimate Real-Time Case Counts and Time-Varying Epidemiological Parameters

Extract a Parameter Summary from a Stan Object

Description

Extracts summarised parameter posteriors from a stanfit object using rstan::summary() in a format consistent with other summary functions in {EpiNow2}.

Usage

extract_stan_param(
  fit,
  params = NULL,
  CrIs = c(0.2, 0.5, 0.9),
  var_names = FALSE
)

Arguments

fit	A ⁠<stanfit>⁠ objec.
params	A character vector of parameters to extract. Defaults to all parameters.
CrIs	Numeric vector of credible intervals to calculate.
var_names	Logical defaults to FALSE. Should variables be named. Automatically set to TRUE if multiple parameters are to be extracted.

Value

A ⁠<data.table>⁠ summarising parameter posteriors. Contains a following variables: variable, mean, mean_se, sd, median, and lower_, upper_ followed by credible interval labels indicating the credible intervals present.

epiforecasts/EpiNow2 documentation built on Dec. 20, 2024, 10:12 p.m.