summary.epinowcast: Summary method for epinowcast

In seabbs/epinowcast: Flexible Hierarchical Nowcasting

Summary method for epinowcast

Description

summary method for class "epinowcast".

Usage

## S3 method for class 'epinowcast'
summary(
  object,
  type = c("nowcast", "nowcast_samples", "fit", "posterior_prediction"),
  max_delay = object$max_delay,
  ...
)

Arguments

object	A data.table output from epinowcast().
type	Character string indicating the summary to return; enforced by base::match.arg(). Supported options are: "nowcast" which summarises nowcast posterior with enw_nowcast_summary(), "nowcast_samples" which samples latest with enw_nowcast_samples(), "fit" which returns the summarised cmdstanr fit with enw_posterior(), "posterior_prediction" which returns summarised posterior predictions for the observations after fitting using enw_pp_summary().
max_delay	Maximum delay to which nowcasts should be summarised. Must be equal (default) or larger than the modelled maximum delay. If it is larger, then nowcasts for unmodelled dates are added by assuming that case counts beyond the modelled maximum delay are fully observed.
...	Additional arguments passed to summary specified by type.

Value

A summary data.frame

See Also

summary epinowcast

Other epinowcast: epinowcast(), plot.epinowcast()

Examples

nowcast <- enw_example("nowcast")

# Summarise nowcast posterior
summary(nowcast, type = "nowcast")

# Nowcast posterior samples
summary(nowcast, type = "nowcast_samples")

# Nowcast model fit
summary(nowcast, type = "fit")

# Posterior predictions
summary(nowcast, type = "posterior_prediction")

seabbs/epinowcast documentation built on Oct. 8, 2024, 8:35 p.m.