R/data.r

#' @title Unit test data
#' 
#' @description Precompiled unit test data for the S3 generic \code{\link[apaformat]{apa.regression.lm}}
#'
#' @format A data frame with 40 rows and 3 variables:
#' \describe{
#'   \item{Subject}{The subject in the study}
#'   \item{Treatment}{The treatment applied to the subject. Treatment 1 is control}
#'   \item{Response}{The response variable at interest}
#' }
#'
#' @source self generated using \code{\link[stats]{rnorm}}
#' 
"testdata.apa.regression.lm"

#' @title Unit test data
#' 
#' @description Precompiled unit test data for the S3 generic \code{\link[apaformat]{apa.regression.lmerModLmerTest}}
#'
#' @format A data frame with 40 rows and 4 variables:
#' \describe{
#'   \item{Subject}{The subject in the study}
#'   \item{FocusGroup}{The focus group the Subject belonged to}
#'   \item{Treatment}{The treatment applied to the subject. Treatment 1 is control}
#'   \item{Response}{The response variable at interest}
#' }
#'
#' @source self generated using \code{\link[stats]{rnorm}}
#' 
"testdata.apa.regression.lmerModLmerTest"

#' @title Unit test data
#' 
#' @description Precompiled unit test data for the S3 generic \code{\link[apaformat]{apa.regression.glm}}
#'
#' @format A data frame with 40 rows and 3 variables:
#' \describe{
#'   \item{Subject}{The subject in the study}
#'   \item{Attribute}{The subject's attribute of interest}
#'   \item{Response}{The response variable at interest (binary)}
#' }
#'
#' @source self generated using \code{\link[stats]{rnorm}}
#' 
"testdata.apa.regression.glm"

#' @title Unit test data
#' 
#' @description Precompiled unit test data for the S3 generic \code{\link[apaformat]{apa.regression.glmerMod}}
#'
#' @format A data frame with 40 rows and 4 variables:
#' \describe{
#'   \item{Subject}{The subject in the study}
#'   \item{FocusGroup}{The focus group the Subject belonged to}
#'   \item{Attribute}{The subject's attribute of interest}
#'   \item{Response}{The response variable at interest (binary)}
#' }
#'
#' @source self generated using \code{\link[stats]{rnorm}}
#' 
"testdata.apa.regression.glmerMod"
markanewman/apaformat documentation built on May 10, 2019, 1:19 a.m.