summary.estimate_infections function

Summary output from estimate_infections

summary method for class "estimate_infections".

## S3 method for class 'estimate_infections'
summary(
  object,
  type = c("snapshot", "parameters", "samples"),
  date = NULL,
  params = NULL,
  ...
)

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.
• date: A date in the form "yyyy-mm-dd" to inspect estimates for.
• params: A character vector of parameters to filter for.
• ...: Pass additional arguments to report_summary

Returns

Returns a <data.frame> of summary output

See Also

summary estimate_infections report_summary