R/data.R

In Amherst-Statistics/katherinemansfieldr: A Package for Text Mining Katherine Mansfield's Short Stories

#' "The Garden Party, and Other Stories"
#'
#' A dataset containing the full text of "The Garden Party, 
#' and Other Stories" by Katherine Mansfield. The UTF-8 plain text was
#' sourced from the ebooks.adelaide.edu.au website. Each line represents a 
#' paragraph in the original text.
#'
#' @usage gardenParty
#'
#' @format A character vector with 1541 elements
#'
#' @source \url{https://ebooks.adelaide.edu.au/m/mansfield/katherine/garden/index.html}
#' 
"gardenParty"

#' "Bliss, and Other Stories"
#'
#' A dataset containing the full text of "Bliss, 
#' and Other Stories" by Katherine Mansfield. The UTF-8 plain text was
#' sourced from the ebooks.adelaide.edu website. Each line represents a 
#' paragraph in the original text.
#'
#' @usage bliss
#'
#' @format A character vector with 1622 elements
#'
#' @source \url{https://ebooks.adelaide.edu.au/m/mansfield/katherine/bliss/index.html}
#' 
"bliss"

#' "Something Childish, and Other Stories"
#'
#' A dataset containing the full text of "Something Childish, 
#' and Other Stories" by Katherine Mansfield. The UTF-8 plain text was
#' sourced from the ebooks.adelaide.edu.au website. Each line represents a 
#' paragraph in the original text.
#'
#' @usage somethingChildish
#'
#' @format A character vector with 1411 elements
#'
#' @source \url{https://ebooks.adelaide.edu.au/m/mansfield/katherine/something/index.html}
#' 
"somethingChildish"

#' Katherine Mansfield's Complete Works
#'
#' A dataset containing the full texts of "Something Childish, 
#' and Other Stories", "Bliss, and Other Stories", and "The Garden
#' Party, and Other Stories" by Katherine Mansfield. The UTF-8 plain text was
#' sourced from the ebooks.adelaide.edu.au website. Each line represents a 
#' paragraph in the original text.
#'
#' @usage mansfieldComplete
#'
#' @format A character vector with 4574 elements
#'
#' @source \url{https://ebooks.adelaide.edu.au/m/mansfield/katherine/}
#' 
"mansfieldComplete"

#' Analysis Table of Katheirne Mansfield's Complete Works
#'
#' A dataset containing the make_analysis_df() output for 
#' the mansfieldComplete dataset, including a year and period variable.
#'
#' @usage completeAnalysisTable
#'
#' @format A data table with 54 observations (each row representing one story) and
#' 27 variables (columns)
#'
#' 
"completeAnalysisTable"