R/data-tabts.R

In R4VN: Health Data Analysis and Publication-Ready Reporting

#' Example monthly dengue time series
#'
#' A reproducible synthetic monthly time-series dataset for demonstrating
#' `tabts()`. It contains 96 monthly observations from January 2018 through
#' December 2025. The data were simulated for teaching and software testing;
#' they do not represent a real surveillance system.
#'
#' @format A data frame with 96 rows and 6 variables:
#' \describe{
#'   \item{month}{Monthly date (first day of month).}
#'   \item{cases}{Synthetic monthly dengue case count.}
#'   \item{rainfall}{Synthetic monthly rainfall in mm.}
#'   \item{temperature}{Synthetic mean monthly temperature in degrees C.}
#'   \item{population}{Synthetic population denominator.}
#'   \item{intervention}{0 before January 2023 and 1 thereafter.}
#' }
#' @source Synthetic data generated for R4VN examples.
"dengue_ts"

#' Example controlled interrupted time-series data
#'
#' Synthetic long-format controlled ITS dataset with a Control and an
#' Intervention series observed monthly over the same 96-month period.
#'
#' @format A data frame with 192 rows and 7 variables:
#' \describe{
#'   \item{month}{Monthly date.}
#'   \item{group}{Control or Intervention series.}
#'   \item{cases}{Synthetic monthly case count.}
#'   \item{rainfall}{Synthetic monthly rainfall in mm.}
#'   \item{temperature}{Synthetic mean monthly temperature in degrees C.}
#'   \item{population}{Synthetic population denominator.}
#'   \item{intervention}{Indicator used for teaching; intervention applies to
#'   the Intervention group from January 2023 onward.}
#' }
#' @source Synthetic data generated for R4VN examples.
"dengue_its_control"