box_plot_max_weekly_cases: Create box plots of maximum weekly cases by scenario

Description Usage Arguments Author(s)

View source: R/box_plot_max_weekly_cases.R

Description

Create box plots of maximum weekly cases by scenario

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
box_plot_max_weekly_cases(
  results = NULL,
  cap_cases = 5000,
  extinct_thresold = 0.1,
  theta_value = "15%",
  prop_asym = 0,
  facet_scales = "fixed",
  filt_control_effectiveness = 0.4,
  flip_coords = FALSE,
  num_initial_cases = 20,
  record_params = FALSE,
  y_lim = NULL
)

Arguments

results

results of the branching model in a data.frame or tibble

cap_cases

the maximimum number of cases per outbreak scenario; default is 5000

theta_value

A Character string defaulting to "15%". Determines the proportion of infections that occur prior to sypmtom onset.

prop_asym

A numeric string defaulting to 0. Filters the proportion of infectiouns are asymptomatic

facet_scales

passed to facet_grid’s scales parameter; default is "fixed"

filt_control_effectiveness

filters by the minimum control effectiveness proportion; default is 0.4

flip_coords

flip coordinates of the box plot; default is FALSE

num_initial_cases

filters by the number of initial cases in the scenario; default is 40

record_params

option to display the params as a caption (used for testing); default FALSE

y_lim

Numeric the limit of the y axis to show.

extinct_threshold

filters the minimum proportion of simulations that become extinct per scenario; default 0.8

Author(s)

Amy Gimma and Sam Abbott


covid19risk/impact-sim documentation built on April 16, 2021, 2:15 a.m.