summary.estimate_infections: Summary output from estimate_infections

In EpiNow2: Estimate Real-Time Case Counts and Time-Varying Epidemiological Parameters

Summary output from estimate_infections

Description

summary method for class "estimate_infections".

Usage

## 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

Value

Returns a ⁠<data.frame>⁠ of summary output

See Also

summary estimate_infections report_summary

EpiNow2 documentation built on Oct. 31, 2024, 5:09 p.m.