stat_dia_names: Positions for variable names in ggcorrm plots

Description Usage Arguments Details Value See Also

View source: R/stat_dia_names.R

Description

stat_dia_names() is used by dia_names() to compute the positions of layer names in the diagonal panels of ggcorrm plots.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
stat_dia_names(
  mapping = NULL,
  data = NULL,
  geom = "text",
  position = "identity",
  show.legend = NA,
  inherit.aes = TRUE,
  y_pos = 0.2,
  ...
)

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

geom

The geometric object to use display the data

position

Position adjustment, either as a string, or the result of a call to a position adjustment function.

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

y_pos

numeric between 0 and 1 specifying the relative position of the text labels along the x axis (defaults to 0.2).

...

Additional arguments passed to ggplot2::layer().

Details

stat_dia_names() uses the range of variables on the diagonal facets ofggcorrm plots to compute appropriate positions for text labels of variable names.

Value

An object of class Layer.

See Also

ggplot2::layer(), dia_names


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