gf_rugx()
and gf_rugy()
are versions that only add a rug to x- or y- axis.
By default, these functions do not inherit from the formula in the original layer
(because doing so would often result in rugs on both axes), so the formula is required.
gf_rug(
object = NULL,
gformula = NULL,
data = NULL,
...,
sides = "bl",
alpha,
color,
group,
linetype,
linewidth,
xlab,
ylab,
title,
subtitle,
caption,
geom = "rug",
stat = "identity",
position = "identity",
show.legend = NA,
show.help = NULL,
inherit = TRUE,
environment = parent.frame()
)
gf_rugx(
object = NULL,
gformula = NULL,
data = NULL,
...,
sides = "b",
alpha,
color,
group,
linetype,
linewidth,
height = 0,
xlab,
ylab,
title,
subtitle,
caption,
geom = "rug",
stat = "identity",
position = "identity",
show.legend = NA,
show.help = NULL,
inherit = FALSE,
environment = parent.frame()
)
gf_rugy(
object = NULL,
gformula = NULL,
data = NULL,
...,
sides = "l",
alpha,
color,
group,
linetype,
linewidth,
width = 0,
xlab,
ylab,
title,
subtitle,
caption,
geom = "rug",
stat = "identity",
position = "identity",
show.legend = NA,
show.help = NULL,
inherit = FALSE,
environment = parent.frame()
)
When chaining, this holds an object produced in the earlier portions of the chain. Most users can safely ignore this argument. See details and examples.
A formula with shape y ~ x
(gf_rug()
) or ~ x
(gf_rugx()
) or
~ y
(gf_rugy()
).
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 ggplot()
.
A data.frame
, or other object, will override the plot
data. All objects will be fortified to produce a data frame. See
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. A function
can be created
from a formula
(e.g. ~ head(.x, 10)
).
Additional arguments. Typically these are
(a) ggplot2 aesthetics to be set with attribute = value
,
(b) ggplot2 aesthetics to be mapped with attribute = ~ expression
, or
(c) attributes of the layer as a whole, which are set with attribute = value
.
A string that controls which sides of the plot the rugs appear on.
It can be set to a string containing any of "trbl"
, for top, right,
bottom, and left.
Opacity (0 = invisible, 1 = opaque).
A color or a formula used for mapping color.
Used for grouping.
A linetype (numeric or "dashed", "dotted", etc.) or a formula used for mapping linetype.
A numerical line width or a formula used for mapping linewidth.
Label for x-axis. See also gf_labs()
.
Label for y-axis. See also gf_labs()
.
Title, sub-title, and caption for the plot.
See also gf_labs()
.
A character string naming the geom used to make the layer.
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 the stat_
prefix (e.g. "count"
rather than
"stat_count"
)
Position adjustment, either as a string naming the adjustment
(e.g. "jitter"
to use position_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.
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.
If TRUE
, display some minimal help.
A logical indicating whether default attributes are inherited.
An environment in which to look for variables not found in data
.
amount of vertical jittering when position is jittered.
amount of horizontal jittering when position is jittered.
a gg object
Positional attributes (a.k.a, aesthetics) are specified using the formula in gformula
.
Setting and mapping of additional attributes can be done through the
use of additional arguments.
Attributes can be set can be set using arguments of the form attribute = value
or
mapped using arguments of the form attribute = ~ expression
.
In formulas of the form A | B
, B
will be used to form facets using
facet_wrap()
or facet_grid()
.
This provides an alternative to
gf_facet_wrap()
and
gf_facet_grid()
that is terser and may feel more familiar to users
of lattice.
Evaluation of the ggplot2 code occurs in the environment of gformula
.
This will typically do the right thing when formulas are created on the fly, but might not
be the right thing if formulas created in one environment are used to create plots
in another.
data(penguins, package = "palmerpenguins")
gf_point(bill_length_mm ~ bill_depth_mm, data = penguins) |>
gf_rug(bill_length_mm ~ bill_depth_mm)
#> Warning: Removed 2 rows containing missing values (`geom_point()`).
# There are several ways to control x- and y-rugs separately
gf_point(bill_length_mm ~ bill_depth_mm, data = penguins) |>
gf_rugx(~bill_depth_mm, data = penguins, color = "red") |>
gf_rugy(bill_length_mm ~ ., data = penguins, color = "green")
#> Warning: Removed 2 rows containing missing values (`geom_point()`).
gf_point(bill_length_mm ~ bill_depth_mm, data = penguins) |>
gf_rug(. ~ bill_depth_mm, data = penguins, color = "red", inherit = FALSE) |>
gf_rug(bill_length_mm ~ ., data = penguins, color = "green", inherit = FALSE)
#> Warning: Removed 2 rows containing missing values (`geom_point()`).
gf_point(bill_length_mm ~ bill_depth_mm, data = penguins) |>
gf_rug(. ~ bill_depth_mm, data = penguins, color = "red", sides = "b") |>
gf_rug(bill_length_mm ~ ., data = penguins, color = "green", sides = "l")
#> Warning: Removed 2 rows containing missing values (`geom_point()`).
# jitter requires both an x and a y, but we can turn off one or the other with sides
gf_jitter(bill_length_mm ~ bill_depth_mm, data = penguins) |>
gf_rug(color = "green", sides = "b", position = "jitter")
#> Warning: Removed 2 rows containing missing values (`geom_point()`).
# rugs work with some 1-varialbe plots as well.
gf_histogram(~eruptions, data = faithful) |>
gf_rug(~eruptions, data = faithful, color = "red") |>
gf_rug(~eruptions, data = faithful, color = "navy", sides = "t")
# we can take advantage of inheritance to shorten the code
gf_histogram(~eruptions, data = faithful) |>
gf_rug(color = "red") |>
gf_rug(color = "navy", sides = "t")
# Need to turn off inheritance when using gf_dhistogram:
gf_dhistogram(~eruptions, data = faithful) |>
gf_rug(~eruptions, data = faithful, color = "red", inherit = FALSE)
# using jitter with gf_histogram() requires manually setting the y value.
gf_dhistogram(~bill_depth_mm, data = penguins) |>
gf_rug(0 ~ bill_depth_mm, data = penguins, color = "green", sides = "b", position = "jitter")
#> Warning: Removed 2 rows containing non-finite values (`stat_bin()`).
# the choice of y value can affect how the plot looks.
gf_dhistogram(~bill_depth_mm, data = penguins) |>
gf_rug(0.5 ~ bill_depth_mm, data = penguins, color = "green", sides = "b", position = "jitter")
#> Warning: Removed 2 rows containing non-finite values (`stat_bin()`).