EpiNow2 (version 1.8.0)

summary.epinow: Summary output from epinow

Description

summary method for class "epinow". This method inherits from summary.estimate_infections() and supports the same arguments.

Usage

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

Value

Returns a <data.frame> of summary output

Arguments

object

An <epinow> object as produced by epinow().

output

Use the type argument instead. Previously supported "estimates", "forecast", and "estimated_reported_cases".

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.

Note: type = "samples" is deprecated. Use get_samples() instead.

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 summary arguments to summary.estimate_infections()

See Also

summary.estimate_infections() epinow()