regional_summary: Generate Regional Summary Output

In epiforecasts/EpiNow: Estimate Realtime Case Counts and Time-varying Epidemiological Parameters

Description

Generate Regional Summary Output

Usage

regional_summary(
  results_dir = NULL,
  summary_dir = NULL,
  target_date = NULL,
  region_scale = "Region",
  csv_region_label = "region",
  log_cases = FALSE
)

Arguments

results_dir	A character string indicating the location of the results directory to extract results from.
summary_dir	A character string giving the directory in which to store summary of results.
target_date	A character string giving the target date for which to extract results (in the format "yyyy-mm-dd").
region_scale	A character string indicating the name to give the regions being summarised.
csv_region_label	Character string indicating the label to assign to a region when saving to .csv.
log_cases	Logical, should cases be shown on a logged scale. Defaults to FALSE

Examples

## Not run: 

## Example asssumes that CovidGlobalNow (github.com/epiforecasts/covid-global) is  
## in the directory above the root.
regional_summary(results_dir = "../covid-global/national",
                 summary_dir = "../covid-global/national-summary",
                 target_date = "2020-03-19",
                 region_scale = "Country")


## End(Not run)

epiforecasts/EpiNow documentation built on Oct. 26, 2020, 2:38 p.m.