Prepare overview summary statistics for medication indicators — prepare_overview

Generates a structured summary of medication usage statistics for different indicators across various categories. The function processes raw data and configuration settings to create organized, indicator-specific summaries suitable for report generation.

Usage

prepare_overview_summary(indicator, data_summary, config)

Arguments

indicator: Character string specifying the medication indicator to summarize. Must be one of: "psychotropics", "antipsychotics", "antidepressants", "antiepileptics", "hypnotics", "polypharmacy", "antibiotics", "antivirals", or "opioids".
data_summary: List containing overall and provider-specific summary statistics. Must include an 'overall_mean' element with columns for indicator, variant, and rate.
config: List containing configuration settings. Must include 'national' element with reference values for relevant indicators (e.g., antipsychotics, polypharmacy).

Value

A list containing structured summary statistics specific to the requested indicator. The structure varies by indicator type:

For most medications: overall usage rates, rates by dementia status
For antipsychotics/polypharmacy: additional national comparisons
For antibiotics: DOT rates and usage percentages
For antivirals: overall and COVID-specific rates

Examples

if (FALSE) { # \dontrun{
# Prepare antipsychotics summary
antipsych_summary <- prepare_overview_summary(
  indicator = "antipsychotics",
  data_summary = list(
    overall_mean = data.table(
      indicator = "antipsychotics",
      variant = c("overall", "dementia", "no dementia"),
      rate = c(15.2, 20.1, 10.3)
    )
  ),
  config = list(
    national = list(
      antipsychotics = 17.9
    )
  )
)

# Prepare antibiotics summary
antibiotics_summary <- prepare_overview_summary(
  indicator = "antibiotics",
  data_summary = list(
    overall_mean = data.table(
      indicator = "antibiotics",
      variant = c("dot", "usage"),
      rate = c(85.3, 25.4)
    )
  ),
  config = list(national = list())
)
} # }