Timely shipment of AFP stool samples

Generates a violin plot highlighting the median detection time of stool shipment to lab.

Usage

generate_timely_ship_violin(
  afp_data,
  start_date,
  end_date,
  priority_level = c("HIGH", "MEDIUM", "LOW (WATCHLIST)", "LOW"),
  who_region = NULL,
  rolling = TRUE,
  output_path = Sys.getenv("KPI_FIGURES"),
  y_max = 60
)

Arguments

afp_data

list AFP data.

start_date

str Analysis start date formatted as "YYYY-MM-DD".

end_date

str Analysis end date formatted as "YYYY-MM-DD".

priority_level

list Priority levels to display. Defaults to c("HIGH", "MEDIUM", "LOW (WATCHLIST)", "LOW").

who_region

list Regions to display. Defaults to NULL, which shows all of the regions.

rolling

logical Using rolling periods or year-to-year? Defaults to TRUE.

output_path

str Where to output the figure to.

y_max

num The maximum y-axis value.

Value

ggplot A violin plot showing timeliness of detection.

Examples

if (FALSE) { # \dontrun{
raw_data <- get_all_polio_data()
generate_timely_ship_violin(raw_data$afp, "2021-01-01", "2023-12-31")
} # }