A layer is a combination of data, stat and geom with a potential position
adjustment. Usually layers are created using geom_*
or stat_*
calls but it can also be created directly using this function.
Usage
layer(
geom = NULL,
stat = NULL,
data = NULL,
mapping = NULL,
position = NULL,
params = list(),
inherit.aes = TRUE,
check.aes = TRUE,
check.param = TRUE,
show.legend = NA,
key_glyph = NULL,
layer_class = Layer
)
Arguments
- geom
The geometric object to use to display the data, either as a
ggproto
Geom
subclass or as a string naming the geom stripped of thegeom_
prefix (e.g."point"
rather than"geom_point"
)- stat
The statistical transformation to use on the data for this layer, either as a
ggproto
Geom
subclass or as a string naming the stat stripped of thestat_
prefix (e.g."count"
rather than"stat_count"
)- 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. Afunction
can be created from aformula
(e.g.~ head(.x, 10)
).- mapping
Set of aesthetic mappings created by
aes()
. 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.- position
Position adjustment, either as a string naming the adjustment (e.g.
"jitter"
to useposition_jitter
), or the result of a call to a position adjustment function. Use the latter if you need to change the settings of the adjustment.- params
Additional parameters to the
geom
andstat
.- 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()
.- check.aes, check.param
If
TRUE
, the default, will check that supplied parameters and aesthetics are understood by thegeom
orstat
. UseFALSE
to suppress the checks.- 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. It can also be a named logical vector to finely select the aesthetics to display.- key_glyph
A legend key drawing function or a string providing the function name minus the
draw_key_
prefix. See draw_key for details.- layer_class
The type of layer object to be constructed. This is intended for ggplot2 internal use only.
Examples
# geom calls are just a short cut for layer
ggplot(mpg, aes(displ, hwy)) + geom_point()
# shortcut for
ggplot(mpg, aes(displ, hwy)) +
layer(
geom = "point", stat = "identity", position = "identity",
params = list(na.rm = FALSE)
)
# use a function as data to plot a subset of global data
ggplot(mpg, aes(displ, hwy)) +
layer(
geom = "point", stat = "identity", position = "identity",
data = head, params = list(na.rm = FALSE)
)