R/data-tabforest_demo.R

In R4VN: Health Data Analysis and Publication-Ready Reporting

#' Demonstration data for tabforest()
#'
#' A simulated health-research dataset designed specifically for the worked
#' examples in [tabforest()]. It contains binary, continuous, count, and
#' time-to-event outcomes, together with continuous and categorical predictors.
#' A small amount of missing data is intentional so users can compare
#' `sample = "common"` and `sample = "model"`.
#'
#' @format A data frame with 500 rows and 19 variables:
#' \describe{
#'   \item{id}{Participant identifier.}
#'   \item{age}{Age in years.}
#'   \item{sex}{Sex: Female or Male.}
#'   \item{bmi}{Body mass index in kg/m2.}
#'   \item{smoking}{Current smoking: No or Yes.}
#'   \item{alcohol}{Current alcohol use: No or Yes.}
#'   \item{education}{Primary, Secondary, or College.}
#'   \item{treatment}{Control or Intervention.}
#'   \item{hypertension}{Binary outcome: No or Yes.}
#'   \item{depression}{Binary prevalence outcome: No or Yes.}
#'   \item{sbp}{Systolic blood pressure in mmHg; continuous outcome.}
#'   \item{visits}{Number of healthcare visits; count outcome.}
#'   \item{followup}{Follow-up time in years.}
#'   \item{death}{Survival event indicator: 0=censored, 1=death.}
#'   \item{hospital}{Hospital cluster identifier H1-H5.}
#'   \item{age_group}{Age group: <55 or >=55 years.}
#'   \item{obesity}{Demo obesity grouping: No or Yes (BMI >=27.5 for teaching only).}
#'   \item{diabetes}{Simulated diabetes mellitus: No or Yes.}
#'   \item{dyslipidemia}{Simulated dyslipidemia: No or Yes.}
#' }
#'
#' @details
#' The dataset is entirely simulated and contains no real patient information.
#' It is intended for package examples, teaching, testing, and screenshots.
#'
#' @source Simulated by R4VN for reproducible examples; seed 20260813.
#' @family R4VN datasets
#' @examples
#' data(tabforest_demo)
#' str(tabforest_demo)
#' table(tabforest_demo$hypertension, useNA = "ifany")
#' summary(tabforest_demo$sbp)
#'
#' # A CSV copy is also installed for teaching/import demonstrations.
#' p <- system.file("extdata", "tabforest_demo.csv", package = "R4VN")
#' p
"tabforest_demo"