R/doc_linreg_data.R

#' Data sample for the linear regression example
#' @name linreg_data
#' @author V. Vancak
#' @docType data
#' @format A data frame with 1000 rows, and 3 columns. Suitable for a simple linear regression with a dummy variable.
#' \describe{
#'   \item{y}{is the continuous dependent variable}
#'   \item{gr}{is the allocated arm of each subject, where 1 corresponds to treatment, and 0 to control}
#'   \item{x_var}{is the independent continuous variable}
#' }
#'
#' @usage data(linreg_data)
#'
#' @keywords datasets
#'
#' @examples
#' data(linreg_data)
NULL
vancak/NNTcalculator documentation built on April 7, 2022, 3:48 a.m.