run_scenario_grid: Run the scenario analysis grid.

In epiforecasts/WuhanSeedingVsTransmission: The transmissibility of novel Coronavirus in the early stages of the 2019-20 outbreak in Wuhan

Description

Run the scenario analysis grid.

Usage

run_scenario_grid(
  end_date = NULL,
  samples = 1,
  upper_case_bound = NULL,
  start_date = "2019-12-31",
  show_progress = FALSE,
  delay_sample_func = NULL,
  kept_dates = NULL
)

Arguments

end_date	Character string in the format "2020-01-01". The date to run the model too.
samples	Numeric, defaults to 1. The number of samples to take for each scenario.
upper_case_bound	Numeric, defaults to NULL. The upper bound on the number of cases that will be modelled
start_date	Character string in the format "2020-01-01". The date to start the outbreak from + the event duration.
show_progress	Logical, defaults to FALSE. Show progress be shown.
delay_sample_func	Function to generate sample reporting delays. If not supplied defaults to a delay function fitted to the linelist of Chinese cases.
kept_dates	Character vector with dates in the format "2020-01-01". Indicates which dates to return data on. Defaults to all time points

Value

A data.frame of scenarios as returned by scenario_analysis

Author(s)

Sam Abbott

Examples

## Example
## Not run: 
grid_results <- run_scenario_grid(end_date = "2020-01-25", samples = 1, 
                  upper_case_bound = 100, show_progress = TRUE, 
                  kept_dates = c("2020-01-01", "2020-01-08", "2020-01-15", "2020-01-25"))
                  
grid_results

## End(Not run)

## Code
run_scenario_grid

epiforecasts/WuhanSeedingVsTransmission documentation built on Feb. 12, 2020, 9:30 p.m.