Permalink
Fetching contributors…
Cannot retrieve contributors at this time
74 lines (62 sloc) 2.74 KB
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/stat-fivenumber.R
\docType{data}
\name{stat_fivenumber}
\alias{stat_fivenumber}
\alias{StatFivenumber}
\title{Calculate components of a five-number summary}
\usage{
stat_fivenumber(mapping = NULL, data = NULL, geom = "boxplot", qs = c(0,
0.25, 0.5, 0.75, 1), na.rm = FALSE, position = "identity",
show.legend = NA, inherit.aes = TRUE, ...)
}
\arguments{
\item{mapping}{Set of aesthetic mappings created by \code{\link{aes}} or
\code{\link{aes_}}. If specified and \code{inherit.aes = TRUE} (the
default), it is combined with the default mapping at the top level of the
plot. You must supply \code{mapping} if there is no plot mapping.}
\item{data}{The data to be displayed in this layer. There are three
options:
If \code{NULL}, the default, the data is inherited from the plot
data as specified in the call to \code{\link{ggplot}}.
A \code{data.frame}, or other object, will override the plot
data. All objects will be fortified to produce a data frame. See
\code{\link{fortify}} for which variables will be created.
A \code{function} will be called with a single argument,
the plot data. The return value must be a \code{data.frame.}, and
will be used as the layer data.}
\item{geom}{The geometric object to use display the data}
\item{qs}{Quantiles to use for the five number summary.}
\item{na.rm}{If \code{FALSE} (the default), removes missing values with
a warning. If \code{TRUE} silently removes missing values.}
\item{position}{Position adjustment, either as a string, or the result of
a call to a position adjustment function.}
\item{show.legend}{logical. Should this layer be included in the legends?
\code{NA}, the default, includes if any aesthetics are mapped.
\code{FALSE} never includes, and \code{TRUE} always includes.}
\item{inherit.aes}{If \code{FALSE}, overrides the default aesthetics,
rather than combining with them. This is most useful for helper functions
that define both data and aesthetics and shouldn't inherit behaviour from
the default plot specification, e.g. \code{\link{borders}}.}
\item{...}{other arguments passed on to \code{\link{layer}}. These are
often aesthetics, used to set an aesthetic to a fixed value, like
\code{color = "red"} or \code{size = 3}. They may also be parameters
to the paired geom/stat.}
}
\value{
A data frame with additional columns:
\item{width}{width of boxplot}
\item{min}{minimum}
\item{lower}{lower hinge, 25\% quantile}
\item{middle}{median, 50\% quantile}
\item{upper}{upper hinge, 75\% quantile}
\item{max}{maximum}
}
\description{
The five number summary of a sample is the minimum, first quartile,
median, third quartile, and maximum.
}
\seealso{
\code{\link{stat_boxplot}}
}
\keyword{datasets}