stat_heatmap: Compute correlation heatmaps for ggcorrm plots

In r-link/corrmorant: Flexible Correlation Matrices Based on 'ggplot2'

Description

stat_heatmap() is used to compute bivariate correlations and display them as correlation heat maps in the facets of ggcorrm plots.

Usage

stat_heatmap(
  mapping = NULL,
  data = NULL,
  geom = "rect",
  position = "identity",
  show.legend = NA,
  inherit.aes = TRUE,
  corr_method = NULL,
  ...
)

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().
corr_method	character string with the correlation method passed to cor(). Can be one of "pearson", "kendall" and "spearman". Defaults to "pearson" (or is inherited from the setting in ggcorrm()).
...	additional arguments passed to ggplot2::layer().

Details

stat_heatmap() computes the correlation between variables in the facets of ggcorrm plots and returns the aesthetics necessary to color facets by correlation strength-

Value

An object of class Layer.

See Also

ggplot2::layer(), add_heatmap()

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