R/spam_load.R

In leahannejohnson/textclassificationexamples: Example Datasets and Functions for Text Classification MEAs

#' Email Subject Lines
#'
#' This dataset includes a set of email subject lines used for classification
#' of whether the message is spam (unsolicited commercial content) or not.
#' Many subject lines include  subject matter innapropriate for classroom use. 
#' Given the volume of headlines containing such language 
#' (especially for type == "spam"), user discretion is advised.
#'
#' @docType data
#' @format A data frame with 6,908 rows and 3 variables:
#' \describe{
#'   \item{subjectline}{character Email subject line}
#'   \item{type}{character Email classification into three levels: spam, hard_ham, and easy_ham}
#'   \item{ids}{integer Row number}
#' }
#' @source \url{http://www.rdatasciencecases.org/Spam}
"emails"
#' Email Train
#'
#' This dataset is a random sample of 80\% of the emails data, stratified by type.
#'
#' @docType data
#' @format A data frame with 5,526 rows and 3 variables:
#' \describe{
#'   \item{subjectline}{character Email subject line}
#'   \item{type}{character Email classification into three levels: spam, hard_ham, and easy_ham}
#'   \item{ids}{integer Original row number}
#' }
#' @source \url{http://www.rdatasciencecases.org/Spam}
"emails_train"
#' Email Test
#'
#' This dataset is a random sample of 20\% of the emails data, stratified by type.
#'
#' @docType data
#' @format A data frame with 1,382 rows and 3 variables:
#' \describe{
#'   \item{subjectline}{character Email subject line}
#'   \item{type}{character Email classification into three levels: spam, hard_ham, and easy_ham}
#'   \item{ids}{integer Original row number}
#' }
#' @source \url{http://www.rdatasciencecases.org/Spam}
"emails_test"