R/fivethirtyeightdata-package.R

In fivethirtyeightdata/fivethirtyeightdata: Data Package For Large FiveThirtyEight datasets

#' fivethirtyeightdata: Data and Code Behind the Stories and Interactives at 'FiveThirtyEight'
#'
#' An add-on R data package that contains the large datasets not found in the original 
#' `fivethirtyeight` package via a drat repository \url{https://github.com/fivethirtyeightdata/drat}
#' published by FiveThirtyEight \url{https://github.com/fivethirtyeight/data}. Note
#' that while we received guidance from editors at 538, this package is not
#' officially published by 538. Contribute to this package at
#' \url{https://github.com/fivethirtyeightdata/fivethirtyeightdata}.
#'
#' @docType package
#' @name fivethirtyeightdata
#' @examples
#' # Example usage:
#' library(fivethirtyeightdata)
#' head(senators)
#'
#' # All information about any data set can be found in the help file:
#' ?senators
#'
#' # To view a list of all data sets:
#' data(package = "fivethirtyeightdata")
NULL