R/TidyCars.R

In gfinak/TidyCars: What the Package Does (One Line, Title Case)

#' TidyCars
#' A data package for TidyCars.
#' @docType package
#' @aliases TidyCars-package
#' @title A tidied cars data set.
#' @name TidyCars
#' @description Cars but better. The variable names are more meaninful.
#' @details The columns have been renamed to indicate the units and better describe what is measured.
#' @seealso
#' \link{tidy_cars}
NULL




#' The stopping distances of cars at different speeds.
#' @name tidy_cars
#' @docType data
#' @title The stopping distances of cars traveling at different speeds.
#' @format a \code{data.frame} containing the following fields:
#' \describe{
#' \item{speed_mph}{The speed of the vehicle.}
#' \item{stopping_distace}{The stopping distance of the vehicle.}
#' }
#' @source The data comes from the cars data set distributed with R.
#' @seealso
#' \link{TidyCars}
NULL