R/vecmatch-package.R

In vecmatch: Generalized Propensity Score Estimation and Matching for Multiple Groups

#' @keywords internal
"_PACKAGE"
#' @title vecmatch
#' @name vecmatch
## usethis namespace: start
## usethis namespace: end
NULL


#' Patients with Colorectal Cancer and Adenoma metadata
#'
#' This is a synthetically generated dataset containing metadata for healthy
#' individuals and patients diagnosed with colorectal cancer or adenomas. The
#' primary purpose of this dataset in the context of matching is to balance the
#' `status` groups across various covariates and achieve optimal matching
#' quality.
#'
#' @format A data frame (`cancer`) with 1,224 rows and 5 columns:
#' \describe{
#'   \item{status}{Patient's health status, which can be one of the following:
#'   \code{healthy}, \code{adenoma}, \code{crc_benign}
#'   (benign colorectal carcinoma), or \code{crc_malignant}
#'   (malignant colorectal carcinoma).}
#'   \item{sex}{Patient's biological sex, recorded as either \code{M} (male) or
#'   \code{F} (female).}
#'   \item{age}{Patient's age, represented as a continuous numeric variable.}
#'   \item{bmi}{Patient's Body Mass Index (BMI), represented as a continuous
#'   numeric variable.}
#'   \item{smoker}{Smoking status of the patient,
#'   recorded as \code{yes} or \code{no}.}
#' }
#' @name cancer
#' @docType data
#' @usage data(cancer)
#' @source Data generated artificially
"cancer"