Summarise y values at unique/binned x x.
Source:R/stat-summary-bin.R
, R/stat-summary.r
stat_summary.Rd
stat_summary
operates on unique x
; stat_summary_bin
operators on binned x
. They are more flexible versions of
stat_bin
: instead of just counting, they can compute any
aggregate.
Usage
stat_summary_bin(
mapping = NULL,
data = NULL,
geom = "pointrange",
position = "identity",
...,
fun.data = NULL,
fun.y = NULL,
fun.ymax = NULL,
fun.ymin = NULL,
fun.args = list(),
na.rm = FALSE,
show.legend = NA,
inherit.aes = TRUE
)
stat_summary(
mapping = NULL,
data = NULL,
geom = "pointrange",
position = "identity",
...,
fun.data = NULL,
fun.y = NULL,
fun.ymax = NULL,
fun.ymin = NULL,
fun.args = list(),
na.rm = FALSE,
show.legend = NA,
inherit.aes = TRUE
)
Arguments
- mapping
Set of aesthetic mappings created by
aes
oraes_
. If specified andinherit.aes = TRUE
(the default), it is combined with the default mapping at the top level of the plot. You must supplymapping
if there is no plot mapping.- data
The data to be displayed in this layer. There are three options:
If
NULL
, the default, the data is inherited from the plot data as specified in the call toggplot
.A
data.frame
, or other object, will override the plot data. All objects will be fortified to produce a data frame. Seefortify
for which variables will be created.A
function
will be called with a single argument, the plot data. The return value must be adata.frame.
, and will be used as the layer data.- geom
The geometric object to use display the data
- position
Position adjustment, either as a string, or the result of a call to a position adjustment function.
- ...
other arguments passed on to
layer
. These are often aesthetics, used to set an aesthetic to a fixed value, likecolor = "red"
orsize = 3
. They may also be parameters to the paired geom/stat.- fun.data
A function that is given the complete data and should return a data frame with variables
ymin
,y
, andymax
.- fun.ymin, fun.y, fun.ymax
Alternatively, supply three individual functions that are each passed a vector of x's and should return a single number.
- fun.args
Optional additional arguments passed on to the functions.
- na.rm
If
FALSE
(the default), removes missing values with a warning. IfTRUE
silently removes missing values.- show.legend
logical. Should this layer be included in the legends?
NA
, the default, includes if any aesthetics are mapped.FALSE
never includes, andTRUE
always includes.- inherit.aes
If
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.borders
.
Summary functions
You can either supply summary functions individually (fun.y
,
fun.ymax
, fun.ymin
), or as a single function (fun.data
):
- fun.data
Complete summary function. Should take numeric vector as input and return data frame as output
- fun.ymin
ymin summary function (should take numeric vector and return single number)
- fun.y
y summary function (should take numeric vector and return single number)
- fun.ymax
ymax summary function (should take numeric vector and return single number)
A simple vector function is easiest to work with as you can return a single
number, but is somewhat less flexible. If your summary function computes
multiple values at once (e.g. ymin and ymax), use fun.data
.
If no aggregation functions are suppled, will default to
mean_se
.
See also
geom_errorbar
, geom_pointrange
,
geom_linerange
, geom_crossbar
for geoms to
display summarised data