R/data.R

In skgallagher/InfectionTrees: Sample, Analyze, and Plot Infection Trees

#' Subset of Tuberculosis data
#'
#' @description  See references for more details.
#'  The data is collected between 2003-2009 in Maryland, USA.
#'  This is originally from \insertCite{xie2018}{InfectionTrees}

#' @format The object is a data frame of dimension 1137x7.  Each row is a detected case of TB.
#' \describe{
#' \item{sex}{Sex of individual (F/M/Unknown)}
#' \item{county}{County in Maryland of individual}
#' \item{race}{Race of individual (Asian/Black or African American/White)}
#' \item{spsmear}{Smear status of individual (positive/negative/unknown)}
#' \item{hivstatus}{HIV status of individual (positive/negative/unknown)}
#' \item{homeless}{Homelessness status of individual (yes/no)}
#' \item{group}{Cluster ID}
#' \item{rel_time}{detection time relative to first individual in cluster}
#' }
#' @examples
#' head(tb_clean)
#' summary(tb_clean)
#'
#' @references
#' \insertAllCited{}
"tb_clean"