R/tei2r.R

#' tei2r: Import and Parse TEI documents in R
#' 
#' The \code{tei2r} package imports collections of plain-text or TEI-encoded 
#' files into the R environment and makes them available for quantitative 
#' analysis.
#' 
#' @docType package
#' @name tei2r
#' @author Authors:
#' Michael Gavin and Travis Mullen
#' 
#' @section What it does:
#' The basic purpose of the \code{tei2r} package is to help users get their
#' TEI-encoded files into R. It is specifically designed for use with files
#' generated by the Text Creation Partnership, providing easy access to
#' thousands of early modern and eighteenth-century texts.
#' 
#' For a tutorial that walks through the basics, check out the introductory 
#' vignette, "Introduction: Getting Started with tei2r."
#' 
#' \strong{Basic operations:}
#' \itemize{
#'   \item \code{\link{buildDocList}}: Represents your collection of documents
#'   \item \code{\link{cleanup}}: Normalizes TEI texts to vectors of character data
#'   \item \code{\link{importTexts}}: Moves texts into R
#' }
#' 
#' \strong{Getting Started:}
#' \itemize{
#'   \item \code{\link{tcpSearch}}: Search the TCP index
#'   \item \code{\link{tcpDownload}}: Download files from the TCP's Git repository
#' }
#' 
#' \strong{Sample Data:}
#' \itemize{
#'   \item \code{\link{natlaw}}: A collection of 33 documents related to 17th-cent 
#'                               political theory. (From EEBO-TCP)
#'                               
#'   \item \code{\link{richardson}}: The novels of Samuel Richardson. (From ECCO-TCP)
#' }
#' 
#' 
#' @import XML
NULL
michaelgavin/tei2r documentation built on May 22, 2019, 9:50 p.m.