add_corrtext: Text labels for correlations in off-diagonal ggcorrm facets

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

Description

lotri_corrtext() and utri_corrtext() are used to display text labels for the strength of bivariate correlations in the off-diagonal facets of ggcorrm plots.

Usage

lotri_corrtext(
  mapping = NULL,
  nrow = NULL,
  ncol = NULL,
  digits = 2,
  corr_size = TRUE,
  corr_method = NULL,
  squeeze = 0.5,
  byrow = TRUE,
  show.legend = FALSE,
  ...
)

utri_corrtext(
  mapping = NULL,
  nrow = NULL,
  ncol = NULL,
  digits = 2,
  corr_size = TRUE,
  corr_method = NULL,
  squeeze = 0.5,
  byrow = TRUE,
  show.legend = FALSE,
  ...
)

Arguments

mapping	Set of aesthetic mappings created by aes. x and y are set automatically and must not be changed, but all other aesthetics may be manipulated. Defaults to NULL (use standard ggcorrm mapping).
nrow	integer - the number of rows for the correlation labels if grouping aesthetics are present (defaults to NULL - automatic setting of nrow).
ncol	integer - the number of columns for the correlation labels if grouping aesthetics are present (defaults to NULL - automatic setting of ncol).
digits	integer: Number of digits the correlations are rounded to (defaults to 2).
corr_size	logical - should the size aesthetic be expressed as a function of correlation strength? corr_size = TRUE is a shorthand for setting aes(size = abs(..corr..)). Similar expressions can be used to access the correlation calculated by stat_corrtext manually in aes(). Defaults to TRUE.
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()).
squeeze	numeric between 0 an 1. Proportion of the facet width/height the facet labels are restricted to when multiple labels are present (defaults to 0.7 - labels extend over 70% of the extent of the plot).
byrow	logical. Should the correlation labels in plots with multiple groups be filled by rows (byrow = TRUE) or by columns (byrow = FALSE)? Note that the actual number of rows or columns that are filled with values can be below the specified value of nrow or ncol when less rows/columns than specified are needed to reach the total number of groups. Defaults to TRUE.
show.legend	logical. Should this layer be included in the legends? FALSE (the default) never includes, TRUE always includes, and NA includes only if aesthetics are mapped. It can also be a named logical vector to finely select the aesthetics to display.
...	Additional arguments to stat_corrtext.

Details

lotri_corrtext() and utri_corrtext() can be used to display the correlation between variables in the lower or upper triangular facets of ggcorrm plots, respectively. Correlations can be calculated for single groups by using grouping aesthetics such as aes(color = group).

lotri_corrtext() and utri_corrtext() are wrappers around stat_corrtext() that additionally take care of the right specification of aesthetics and allows to easily adjust size by correlation strength via corr_size.

Value

A ggplot2 layer with text labels for correlation strength.

See Also

stat_corrtext

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