Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Tweaks to documentation to pass R CMD check
- Loading branch information
Showing
6 changed files
with
48 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
\name{summarise} | ||
\alias{summarise} | ||
\alias{summarize} | ||
\title{Summarise a data frame.} | ||
\author{Hadley Wickham <h.wickham@gmail.com>} | ||
|
||
\description{ | ||
Create a new data frame that summarises an existing data frame. | ||
} | ||
\usage{summarise(.data, ...)} | ||
\arguments{ | ||
\item{.data}{The data frame to be summarised} | ||
\item{...}{Further arguments of the form var = value} | ||
} | ||
|
||
\details{Summarise works in an analagous way to transform, except instead of adding | ||
columns to an existing data frame, it creates a new one. This is | ||
particularly useful in conjunction with \code{\link{ddply}} as it makes it | ||
easy to perform group-wise summaries.} | ||
|
||
\examples{summarise(baseball, | ||
duration = max(year) - min(year), | ||
nteams = length(unique(team))) | ||
ddply(baseball, "id", summarise, | ||
duration = max(year) - min(year), | ||
nteams = length(unique(team)))} | ||
\keyword{manip} |