Rug plots in the margins • cxplot

A rug plot is a compact visualisation designed to supplement a 2d display with the two 1d marginal distributions. Rug plots display individual cases so are best used with smaller datasets.


geom_rug({
 "mapping" = null,
 "data" = null,
 "stat" = "identity",
 "position" = "identity",
 "...",
 "outside" = false,
 "sides" = "bl",
  length = unit({0.03, "npc"}),
 "na.rm" = false,
 "show.legend" = NA,
 "inherit.aes" = true
})

Arguments

mapping	Set of aesthetic mappings created by `aes()` or `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 `cxplot()`. 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)).
stat	The statistical transformation to use on the data for this layer, as a string.
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, like `color` = "red" or `size` = 3. They may also be parameters to the paired geom/stat.
outside	logical that controls whether to move the rug tassels outside of the plot area. Default is off (FALSE). You will also need to use coord_cartesian(clip = "off"). When set to TRUE, also consider changing the sides argument to "tr". See examples.
sides	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.
length	A grid::unit() object that sets the length of the rug lines. Use scale expansion to avoid overplotting of data.
na.rm	If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.
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 behaviour from the default plot specification, e.g. borders().

Details

By default, the rug lines are drawn with a length that corresponds to 3% of the total plot size. Since the default scale expansion of for continuous variables is 5% at both ends of the scale, the rug will not overlap with any data points under the default settings.

Aesthetics

geom_rug() understands the following aesthetics (required aesthetics are in bold):

alpha

color

group

linetype

size

Learn more about setting these aesthetics in vignette("cxplot-specs").

Examples


var cxp = new cxplot("canvas1", mtcars, aes("wt", "mpg"));
cxp.geom_point();


var cxp = new cxplot("canvas2", mtcars, aes("wt", "mpg"));
cxp.geom_point();
cxp.geom_rug();


var cxp = new cxplot("canvas3", mtcars, aes("wt", "mpg"));
cxp.geom_point();
// Rug on bottom only
cxp.geom_rug({"sides": "b"});


var cxp = new cxplot("canvas4", mtcars, aes("wt", "mpg"));
cxp.geom_point();
// All four sides
cxp.geom_rug({"sides": "trbl"});