Structure OBI data for plotting control charts — create_ctrl

This function takes in a data frame row per observation like OBI data. It then summarize the numerator and denominator of a rate of interest. This function also use control chart principles to calculate CIs and flag alerts.

create_ctrl_df(
  df,
  date_var,
  num_var,
  den_var,
  date_gran = "month",
  nsigmas = 3,
  long = F,
  increase_is_bad = TRUE,
  for_highchart = FALSE
)

Arguments

df: A data frame, for example OBI export data
date_var: The date variable to be used for grouping; usually infant_dob_dt; Make use this variable is in a date format, for example: lubridate::dmy_hms(infant_dob_dt)
num_var: The variable to be summarized as the numerator - should be binary 0 1
den_var: The variable to be summarized as the denominator - should be binary 0 1
date_gran: "month" or "quarter"; The granularity of dates we want to use for our control chart; default is "month".
nsigmas: a numeric value specifying the number of sigmas to use for computing control limits. default to 3.
long: Whether to pivot the data to long format - default is TRUE as this is the data structure needed for ggplot2
increase_is_bad: If TRUE, this is a trend that would ideally be decreasing over time; if FALSE, ideally increasing. default is TRUE.
for_highchart: If TRUE, multiplies all rates by 100 for highchart; default is FALSE.

Value

An tibble with the aggridated numerator and denominator by input date variable