R/yrbss_states_data_binary.R

In gsimchoni/yrbss: An easy R interface to the American CDC Youth Risk Behavior Surveillance System (YRBSS)

#' YRBSS Data - Binary Version - States Data
#'
#' Data from CDC YRBSS - the Binary Version, where multiple choice questions
#' were grouped into two options. The object itself is of class \code{"survey.design2"}
#' from the \code{survey} package, and its raw data can be accessed via
#' \code{yrbss_states_data_binary$variables}, though highly NOT recommended, see references.
#'
#' @docType data
#'
#' @usage data(yrbss_states_data_binary)
#'
#' @format An object of class \code{"survey.design2"}
#'
#' @keywords datasets
#'
#' @references Centers for Disease Control and Prevention. Youth Risk Behavior
#' Survey Questionnaire. Accessed on [2017-06-14].
#' (\href{www.cdc.gov/yrbs}{CDC YRBSS Official Site})
#'
#' @source \href{www.cdc.gov/yrbs}{CDC YRBSS Official Site}
#'
#' @seealso 
#' \code{\link{yrbss_data_binary}}, \code{\link{yrbss_questions_binary}}
#' 
#' @examples
#' data(yrbss_states_data_binary)
"yrbss_states_data_binary"