Skip to content

Commit

Permalink
Update data doc style
Browse files Browse the repository at this point in the history
  • Loading branch information
hadley committed Dec 5, 2014
1 parent 89b4c56 commit 85042ae
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 12 deletions.
16 changes: 5 additions & 11 deletions R/data.r
Original file line number Diff line number Diff line change
Expand Up @@ -19,24 +19,19 @@
#' }
#'
#' @docType data
#' @name french_fries
#' @usage data(french_fries)
#' @format A data frame with 696 rows and 9 variables
#' @keywords datasets
NULL
"french_fries"

#' Demo data describing the Smiths.
#'
#' A small demo dataset describing John and Mary Smith. Used in the
#' introductory vignette.
#'
#' @docType data
#' @name smiths
#' @usage data(smiths)
#' @format A data frame with 2 rows and 5 variables
#' @keywords datasets
NULL

"smiths"

#' Tipping data
#'
Expand All @@ -61,9 +56,8 @@ NULL
#' @references Bryant, P. G. and Smith, M (1995) \emph{Practical Data
#' Analysis: Case Studies in Business Statistics}. Homewood, IL: Richard D.
#' Irwin Publishing:
#' @docType data
#' @name tips
#' @usage data(tips)
#' @format A data frame with 244 rows and 7 variables
#' @keywords datasets
NULL
"tips"


2 changes: 1 addition & 1 deletion man/french_fries.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
\title{Sensory data from a french fries experiment.}
\format{A data frame with 696 rows and 9 variables}
\usage{
data(french_fries)
french_fries
}
\description{
This data was collected from a sensory experiment conducted at Iowa State
Expand Down
15 changes: 15 additions & 0 deletions man/smiths.Rd
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
% Generated by roxygen2 (4.0.2): do not edit by hand
\docType{data}
\name{smiths}
\alias{smiths}
\title{Demo data describing the Smiths.}
\format{A data frame with 2 rows and 5 variables}
\usage{
smiths
}
\description{
A small demo dataset describing John and Mary Smith. Used in the
introductory vignette.
}
\keyword{datasets}

35 changes: 35 additions & 0 deletions man/tips.Rd
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
% Generated by roxygen2 (4.0.2): do not edit by hand
\docType{data}
\name{tips}
\alias{tips}
\title{Tipping data}
\format{A data frame with 244 rows and 7 variables}
\usage{
tips
}
\description{
One waiter recorded information about each tip he received over a
period of a few months working in one restaurant. He collected several
variables:
}
\details{
\itemize{
\item tip in dollars,
\item bill in dollars,
\item sex of the bill payer,
\item whether there were smokers in the party,
\item day of the week,
\item time of day,
\item size of the party.
}

In all he recorded 244 tips. The data was reported in a collection of
case studies for business statistics (Bryant & Smith 1995).
}
\references{
Bryant, P. G. and Smith, M (1995) \emph{Practical Data
Analysis: Case Studies in Business Statistics}. Homewood, IL: Richard D.
Irwin Publishing:
}
\keyword{datasets}

0 comments on commit 85042ae

Please sign in to comment.