R/cvdd.R

In riskCommunicator: G-Computation to Estimate Interpretable Epidemiological Effects

#' A subset of the \code{framingham} teaching data
#'
#' A subset of the \code{framingham} teaching dataset containing the following changes:
#' \itemize{
#' \item{removal of all observations where PERIOD == 2 or PERIOD == 3 (i.e. keep only PERIOD == 1)}
#' \item{removal of all observations where PREVCHD == 1 (i.e. all patients with coronary heart disease at baseline)}
#' \item{created a new variable, \code{cvd_dth} signifying an outcome of cardiovascular disease OR death (i.e. if the patient had either CVD or DEATH, this new variable is 1, otherwise 0)}
#' \item{created a new variable, \code{timeout}, which calculates the number of days from the start of the study to cardiovascular disease, death, or loss to follow-up}
#' \item{created a new variable, \code{logpdays}, which is the log of \code{timeout}}
#' \item{created a new variable, \code{nhosp}, which is a simulated number of hospitalizations}
#' }
#' @format A data frame with 4240 rows and 31 variables:
#' \describe{
#' \item{RANDID}{Unique identification number for each participant.}
#' \item{SEX}{Participant sex. 0 = Male, 1 = Female.}
#' \item{TOTCHOL}{Serum Total Cholesterol (mg/dL).}
#' \item{AGE}{Age at exam (years).}
#' \item{SYSBP}{Systolic Blood Pressure (mean of last two of three measurements) (mmHg).}
#' \item{DIABP}{Diastolic Blood Pressure (mean of last two of three measurements) (mmHg).}
#' \item{CURSMOKE}{Current cigarette smoking at exam. 0 = Not current smoker, 1 = Current smoker.}
#' \item{CIGPDAY}{Number of cigarettes smoked each day. 0 = Not current smoker.}
#' \item{BMI}{Body Mass Index, weight in kilograms/height meters squared.}
#' \item{DIABETES}{Diabetic according to criteria of first exam treated or first exam with casual glucose of 200 mg/dL or more. 0 = Not a diabetic, 1 = Diabetic.}
#' \item{BPMEDS}{Use of Anti-hypertensive medication at exam. 0 = Not currently used, 1 = Current use.}
#' \item{HEARTRTE}{Heart rate (Ventricular rate) in beats/min.}
#' \item{GLUCOSE}{Casual serum glucose (mg/dL).}
#' \item{educ}{Level of completed education. 1 = 0-11 years, 2 = high school or GED, 3 = some college, 4 = college graduate or higher.}
#' \item{PREVSTRK}{Prevalent Stroke. 0 = Free of disease, 1 = Prevalent disease.}
#' \item{PREVHYP}{Prevalent Hypertensive. Subject was defined as hypertensive if treated or if second exam at which mean systolic was >=140 mmHg or mean Diastolic >=90 mmHg. 0 = Free of disease, 1 = Prevalent disease.}
#' \item{DEATH}{Death from any cause. 0 = Did not occur during followup, 1 = Did occur during followup.}
#' \item{ANGINA}{Angina Pectoris. 0 = Did not occur during followup, 1 = Did occur during followup.}
#' \item{HOSPMI}{Hospitalized Myocardial Infarction. 0 = Did not occur during followup, 1 = Did occur during followup.}
#' \item{MI_FCHD}{Hospitalized Myocardial Infarction or Fatal Coronary Heart Disease. 0 = Did not occur during followup, 1 = Did occur during followup.}
#' \item{ANYCHD}{Angina Pectoris, Myocardial infarction (Hospitalized and silent or unrecognized), Coronary Insufficiency (Unstable Angina), or Fatal Coronary Heart Disease. 0 = Did not occur during followup, 1 = Did occur during followup.}
#' \item{STROKE}{Atherothrombotic infarction, Cerebral Embolism, Intracerebral Hemorrhage, or Subarachnoid Hemorrhage or Fatal Cerebrovascular Disease. 0 = Did not occur during followup, 1 = Did occur during followup.}
#' \item{CVD}{Myocardial infarction (Hospitalized and silent or unrecognized), Fatal Coronary Heart Disease, Atherothrombotic infarction, Cerebral Embolism, Intracerebral Hemorrhage, or Subarachnoid Hemorrhage or Fatal Cerebrovascular Disease. 0 = Did not occur during followup, 1 = Did occur during followup.}
#' \item{HYPERTEN}{Hypertensive. Defined as the first exam treated for high blood pressure or second exam in which either Systolic is 6 140 mmHg or Diastolic 6 90mmHg. 0 = Did not occur during followup, 1 = Did occur during followup.}
#' \item{cvd_dth}{Cardiovascular disease OR death. 0 = Did not occur during followup, 1 = Did occur during followup.}
#' \item{timeout}{Number of days from the start of the study to cardiovascular disease, death, or loss to follow-up.}
#' \item{drop}{Participant was lost to follow-up before 24 months complete followup. 0 = no, 1 = yes}
#' \item{glucoseyear6}{Casual serum glucose (mg/dL) after 6 years of follow-up}
#' \item{logpdays}{Natural log of \code{timeout}.}
#' \item{bmicat}{BMI category. 0 = Normal, 1 = Underweight, 2 = Overweight, 3 = Obese.}
#' \item{nhosp}{Simulated number of hospitalizations over 24 months, associated with age, sex, BMI, and diabetes (not collected in the Framingham study).}
#' }
#' @name cvdd
#' @docType data
#' @usage data(cvdd)
#' @details  
#' The National Heart, Lung, and Blood Institute of the National Institutes of 
#' Health developed a longitudinal, epidemiology-focused dataset using the Framingham 
#' Heart Study. The Framingham Heart Study is a long term prospective study of the 
#' etiology of cardiovascular disease among a population of free living subjects in 
#' the community of Framingham, Massachusetts. The Framingham Heart Study was a 
#' landmark study in epidemiology in that it was the first prospective study of 
#' cardiovascular disease and identified the concept of risk factors and their joint 
#' effects. The study began in 1948 and 5,209 subjects were initially enrolled in the 
#' study. Participants have been examined biennially since the inception of the study 
#' and all subjects are continuously followed through regular surveillance for 
#' cardiovascular outcomes. Clinic examination data has included cardiovascular disease 
#' risk factors and markers of disease such as blood pressure, blood chemistry, lung 
#' function, smoking history, health behaviors, ECG tracings, Echocardiography, and 
#' medication use. Through regular surveillance of area hospitals, participant contact, 
#' and death certificates, the Framingham Heart Study reviews and adjudicates events for 
#' the occurrence of Angina Pectoris, Myocardial Infarction, Heart Failure, and 
#' Cerebrovascular disease. This dataset contains three clinic examinations and 20 year 
#' follow-up data on a large subset of the original Framingham cohort participants.
#' 
#' NOTE: This is a "teaching" dataset. Specific methods were employed to ensure an 
#' anonymous dataset that protects patient confidentiality; therefore, this dataset is 
#' inappropriate for publication purposes." The use of these data for the purposes of 
#' this package were approved on 11Mar2019 (request #7161) by NIH/NHLBI.
#'
#' @source
#' \url{https://biolincc.nhlbi.nih.gov/teaching/} 
NULL