- mapping
Set of aesthetic mappings created by ggplot2::aes()
or
ggplot2::aes_()
. If specified and inherit.aes = TRUE
(the
default), it is combined with the default mapping at the top level of the
plot. You must supply mapping
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 to ggplot2::ggplot()
.
A data.frame
, or other object, will override the plot
data. All objects will be fortified to produce a data frame. See
ggplot2::fortify()
for which variables will be created.
A function
will be called with a single argument,
the plot data. The return value must be a data.frame.
, and
will be used as the layer data.
- stat
The statistical transformation to use on the data for this layer.
When using a geom_*()
function to construct a layer, the stat
argument can be used the override the default coupling between geoms and
stats. The stat
argument accepts the following:
A Stat
ggproto subclass, for example StatCount
.
A string naming the stat. To give the stat as a string, strip the
function name of the stat_
prefix. For example, to use stat_count()
,
give the stat as "count"
.
For more information and other ways to specify the stat, see the
layer stat documentation.
- position
A position adjustment to use on the data for this layer. This
can be used in various ways, including to prevent overplotting and
improving the display. The position
argument accepts the following:
The result of calling a position function, such as position_jitter()
.
This method allows for passing extra arguments to the position.
A string naming the position adjustment. To give the position as a
string, strip the function name of the position_
prefix. For example,
to use position_jitter()
, give the position as "jitter"
.
For more information and other ways to specify the position, see the
layer position documentation.
- na.rm
If TRUE
, silently removes NA
values, which
typically desired for moving averages.
- show.legend
logical. Should this layer be included in the legends?
NA
, the default, includes if any aesthetics are mapped.
FALSE
never includes, and TRUE
always includes.
It can also be a named logical vector to finely select the aesthetics to
display.
- 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 behavior from
the default plot specification, e.g. ggplot2::borders()
.
- colour_up, colour_down
Select colors to be applied based on price movement
from open to close. If close >= open
, colour_up
is used. Otherwise,
colour_down
is used. The default is "darkblue"
and "red"
, respectively.
- fill_up, fill_down
Select fills to be applied based on price movement
from open to close. If close >= open, fill_up
is used. Otherwise,
fill_down
is used. The default is "darkblue"
and "red", respectively.
Only affects geom_candlestick()
.
- ...
Other arguments passed on to ggplot2::layer()
. These are
often aesthetics, used to set an aesthetic to a fixed value, like
color = "red"
or size = 3
. They may also be parameters
to the paired geom/stat.