regional_runtimes: Summarise Regional Runtimes

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

Summarise Regional Runtimes

Description

Used internally by regional_epinow to summarise region run times.

Usage

regional_runtimes(
  regional_output = NULL,
  target_folder = NULL,
  target_date = NULL,
  return_output = FALSE
)

Arguments

regional_output	A list of output as produced by regional_epinow() and stored in the regional list.
target_folder	Character string specifying where to save results (will create if not present).
target_date	A character string giving the target date for which to extract results (in the format "yyyy-mm-dd"). Defaults to latest available estimates.
return_output	Logical, defaults to FALSE. Should output be returned, this automatically updates to TRUE if no directory for saving is specified.

Value

A data.table of region run times

See Also

regional_summary regional_epinow

Examples

regional_out <- readRDS(system.file(
    package = "EpiNow2", "extdata", "example_regional_epinow.rds"
))
regional_runtimes(regional_output = regional_out$regional)

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