Skip to contents

Summary output from estimate_infections

Source: R/summarise.R
summary.estimate_infections.Rd

[Stable] summary method for class "estimate_infections".

Usage

# S3 method for class 'estimate_infections'
summary(
  object,
  type = c("snapshot", "parameters"),
  target_date = NULL,
  params = NULL,
  CrIs = c(0.2, 0.5, 0.9),
  ...
)

Arguments

object

A list of output as produced by "estimate_infections".

type

A character vector of data types to return. Defaults to "snapshot" but also supports "parameters", and "samples". "snapshot" return a summary at a given date (by default the latest date informed by data). "parameters" returns summarised parameter estimates that can be further filtered using params to show just the parameters of interest and date. "samples" similarly returns posterior samples.

target_date

Date, defaults to maximum found in the data if not specified.

params

A character vector of parameters to filter for.

CrIs

Numeric vector of credible intervals to calculate.

...

Pass additional arguments to report_summary when type = "snapshot".

Value

Returns a <data.frame> of summary output

See also

summary.epinow() estimate_infections() report_summary()