summary.epimodel: Summary method for epimodel objects

Description Usage Arguments Value

View source: R/summary.R

Description

Provides a summary of parameter estimates and MCMC diagnostics. Similar to summary.stanreg in rstanarm.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## S3 method for class 'epimodel'
summary(
  object,
  pars = NULL,
  regex_pars = NULL,
  probs = c(0.1, 0.5, 0.9),
  ...,
  digits = 1
)

## S3 method for class 'summary.epimodel'
print(x, digits = max(1, attr(x, "print.digits")), ...)

Arguments

object

A fitted model object returned by epim. See epimodel-objects.

pars

A character vector giving a subset of parameters to include. Default is NULL, in which case all parameters are included.

regex_pars

A character vector of regular expressions to select parameters. If pars is also used, regex_pars is used in conjunction with pars.

probs

A numeric vector of probabilities for computing quantiles of parameter estimates.

...

Not used.

digits

Number of digits to use for formatting numbers when printing.

x

An object of class "summary.epimodel".

Value

An object of class "summary.epimodel".


epidemia documentation built on Oct. 25, 2021, 9:09 a.m.