geom_dia_density: Add density curves to the plot diagonal of ggcorrm plots

Description Usage Arguments Details Value See Also

View source: R/geom_dia_density.R

Description

geom_dia_density() rescales the output of ggplot2::stat_density() for the correct display of density curves on the plot diagonal of ggcorrm plots.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
geom_dia_density(
  mapping = NULL,
  data = NULL,
  stat = "density",
  position = "identity",
  ...,
  na.rm = FALSE,
  show.legend = NA,
  inherit.aes = TRUE,
  outline.type = "full"
)

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 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)).

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.

...

Additional arguments passed to ggplot2::layer() (arguments for ggplot2::geom_density() are permitted).

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().

outline.type

Type of the outline of the area; "both" draws both the upper and lower lines, "upper"/"lower" draws the respective lines only. "full" draws a closed polygon around the area.

Details

geom_density() computes density curves for display in the diagonal facets of ggcorrm plots. Its lwr and upr aesthetics can be used to offset the density curves from zero and optimally fit them to the range of each panel.

Value

An object of class Layer.

See Also

ggplot2::geom_density(), dia_density()


r-link/corrmorant documentation built on Jan. 10, 2021, 7:26 p.m.