R/data.R

In DPComb: Discrete p-Value Combination Tests

# This file contains descriptions of built-in data
# Created by ZWu, Feb 13, 2025.


#' Case-Control Study Data
#'
#' A case-control study dataset containing genetic marker mutation indicators as covariates.
#'
#' @docType data
#' @usage data(case_control)
#' @format A data frame with 2000 rows and 16 variables:
#' \describe{
#'   \item{disease_status}{Disease status (1 = case, 0 = control).}
#'   \item{marker1}{Binary mutation indicator for marker 1.}
#'   \item{marker2}{Binary mutation indicator for marker 2.}
#'   \item{marker3}{Binary mutation indicator for marker 3.}
#'   \item{marker4}{Binary mutation indicator for marker 4.}
#'   \item{marker5}{Binary mutation indicator for marker 5.}
#'   \item{marker6}{Binary mutation indicator for marker 6.}
#'   \item{marker7}{Binary mutation indicator for marker 7.}
#'   \item{marker8}{Binary mutation indicator for marker 8.}
#'   \item{marker9}{Binary mutation indicator for marker 9.}
#'   \item{marker10}{Binary mutation indicator for marker 10.}
#'   \item{marker11}{Binary mutation indicator for marker 11.}
#'   \item{marker12}{Binary mutation indicator for marker 12.}
#'   \item{marker13}{Binary mutation indicator for marker 13.}
#'   \item{marker14}{Binary mutation indicator for marker 14.}
#'   \item{marker15}{Binary mutation indicator for marker 15.}
#' }
#' 
#' @details
#' The dataset contains:
#' \itemize{
#'   \item 1000 cases and 1000 controls
#'   \item 15 binary genetic markers. Binary mutation indicator: 1=mutation, 0=wild type. 
#'   \item Number of mutations for each marker:
#'     \itemize{
#'       \item marker1: Total 19 (Cases 13)
#'       \item marker2: Total 16 (Cases 11)
#'       \item marker3: Total 16 (Cases 11)
#'       \item marker4: Total 10 (Cases 7)
#'       \item marker5: Total 13 (Cases 9)
#'       \item marker6: Total 12 (Cases 8)
#'       \item marker7: Total 10 (Cases 7)
#'       \item marker8: Total 12 (Cases 8)
#'       \item marker9: Total 11 (Cases 8)
#'       \item marker10: Total 16 (Cases 11)
#'       \item marker11: Total 19 (Cases 10)
#'       \item marker12: Total 9 (Cases 3)
#'       \item marker13: Total 14 (Cases 6)
#'       \item marker14: Total 8 (Cases 5)
#'       \item marker15: Total 7 (Cases 4)
#'     }
#' }
#' @keywords datasets
#' @examples
#' data(case_control)
#' head(case_control, 3)
#' 
#' #1000 cases and 1000 controls
#' table(case_control$disease_status)
#' 
#' #Marker 1 has 13 mutations in cases and 6 mutations in controls.
#' table(case_control$disease_status, case_control$marker1) 
"case_control"