summary.forecast_infections: Summary output from forecast_infections

In EpiNow2: Estimate and Forecast Real-Time Infection Dynamics

Summary output from forecast_infections

Description

summary method for class "forecast_infections".

Usage

## S3 method for class 'forecast_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 "forecast_infections".
type	A character vector of data types to return. Defaults to "snapshot" but also supports "parameters". "snapshot" returns 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.
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.estimate_infections() forecast_infections() report_summary()

EpiNow2 documentation built on June 17, 2026, 1:07 a.m.