R/data.R

In casxue/bis557: Coursework for BIS 557

#' A test data set for the linear_model() function
#' 
#' @docType data
#'
#' @usage data(lm_patho)
#'
#' @format A data frame with 2 rows and 3 variables:
#' \describe{
#'   \item{y}{--}
#'   \item{x1}{--}
#'   \item{x2}{--}
#' }
#' @source \url{https://github.com/kaneplusplus/bis557/blob/master/data/lm_patho.rda}
"lm_patho"

#' A training data set for testing the ridge_reg() function
#' 
#' @docType data
#'
#' @usage data(ridge_train)
#'
#' @format A data frame with 200 rows and 5 variables:
#' \describe{
#'   \item{y}{--}
#'   \item{x1}{--}
#'   \item{x2}{--} 
#' 	 \item{x3}{--}
#' 	 \item{x4}{--}
#' }
#' @source \url{https://yale.instructure.com/courses/39183/files/folder/homework\%202?}
"ridge_train"

#' A test data set for testing the ridge_reg() function
#' 
#' @docType data
#'
#' @usage data(ridge_test)
#'
#' @format A data frame with 200 rows and 5 variables:
#' \describe{
#'   \item{y}{--}
#'   \item{x1}{--}
#'   \item{x2}{--} 
#' 	 \item{x3}{--}
#' 	 \item{x4}{--}
#' }
#' @source \url{https://yale.instructure.com/courses/39183/files/folder/homework\%202?}
<<<<<<< HEAD
"ridge_test"

#' A training data set from MNIST
#' 
#' @docType data
#'
#' @usage data(mnist_train)
#'
#' @format A data frame with 7291 rows and 257 variables
#' @source \url{https://raw.githubusercontent.com/statsmaths/stat665/gh-pages/data/mnist_test.psv}
"mnist_train"

#' A test data set from MNIST
#' 
#' @docType data
#'
#' @usage data(mnist_test)
#'
#' @format A data frame with 2007 rows and 257 variables:
#' @source \url{https://raw.githubusercontent.com/statsmaths/stat665/gh-pages/data/mnist_test.psv}
"mnist_test"

#' A data set for training, testing, and validation from EMNIST
#' 
#' @docType data
#'
#' @usage data(emnist)
#'
#' @format A data frame with 124800 rows and 4 variables:
#' \describe{
#'   \item{obs_id}{Identifier for each record}
#'   \item{train_id}{Classification of data point as training, testing, or validation}
#'   \item{class}{Integer corresponding to the letter encoded} 
#' 	 \item{letter}{Letter encoded}
#' }
#' @source \url{https://raw.githubusercontent.com/statsmaths/ml_data/master/emnist_26.csv}
"emnist"