MINI MINI MANI MO

%
% Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
%
\name{summarise}
\alias{summarise}
\alias{summarise_}
\title{Summarise Columns by Aggregate Functions}
\usage{
summarise(.data, ...)

summarise_(.data, ..., .dots)
}
\arguments{
\item{.data}{An \code{\link[OREbase:ore.frame-class]{ore.frame}} object.}

\item{...}{Name-value pairs of aggregate functions such as \code{\link{min}()},
\code{\link{mean}()}, \code{\link{max}()}, and so on.}

\item{.dots}{Used to work around non-standard evaluation.
See \code{\link[dplyr]{summarise_}} for details.}
}
\value{
An \code{\link[OREbase:ore.frame-class]{ore.frame}} object.
}
\description{
Aggregates the specified column values. 

When an \code{\link[OREbase:ore.frame-class]{ore.frame}} object is grouped, the 
aggregate function is applied group-wise. The supported aggregate functions are
\code{\link{min}}, \code{\link{mean}}, \code{\link{max}}, \code{\link{median}},
\code{\link{length}}, \code{\link{IQR}}, \code{\link{prod}}, \code{\link{sum}},
\code{\link{range}}, \code{\link{quantile}}, \code{\link{fivenum}},
\code{\link{summary}}, \code{\link{sd}}, \code{\link{var}}, \code{\link{all}},
and \code{\link{any}}. The resulting \code{ore.frame} drops one grouping of
the input \code{ore.frame}.
}
\examples{

MTCARS <- ore.push(mtcars)
summarise(MTCARS, mean(disp))
arrange(summarise(group_by(MTCARS, cyl), mean(disp)), cyl)
arrange(summarise(group_by(MTCARS, cyl), m = mean(disp), r = range(disp)), cyl)

arrange(summarise_(group_by(MTCARS, cyl), m = "mean(disp)", r = quote(range(disp))), cyl)

library(magrittr)
by_cyl <- MTCARS \%>\% group_by(cyl)
by_cyl \%>\% summarise(a = n(), b = n() + 1) \%>\% arrange(cyl)
}
\seealso{
  \code{\link{arrange}},
  \code{\link{arrange_}}; \code{\link{filter}},
  \code{\link{filter_}}; \code{\link{mutate}},
  \code{\link{mutate_}}, \code{\link{transmute}},
  \code{\link{transmute_}}; \code{\link{rename}},
  \code{\link{rename_}}, \code{\link{select}},
  \code{\link{select_}}; \code{\link{slice}},
  \code{\link{slice_}}
}