stat_corrtext: Compute correlation strength for text labels in ggcorrm plots
In r-link/corrmorant: Flexible Correlation Matrices Based on 'ggplot2'

Description Usage Arguments Details Value See Also

stat_corrtext() is used to compute bivariate correlations and appropriate positions of text labels indicating correlation strength for the facets of ggcorrm plots.

stat_corrtext(
  mapping = NULL,
  data = NULL,
  geom = "text",
  position = "identity",
  show.legend = NA,
  inherit.aes = TRUE,
  nrow = NULL,
  ncol = NULL,
  digits = 2,
  corr_method = NULL,
  squeeze = 0.7,
  byrow = TRUE,
  ...
)

`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).
`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? 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.
`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()`.
`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_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`.
`...`	additional arguments passed to `ggplot2::layer()`.

stat_corrtext() computes the correlation between variables in the facets of ggcorrm plots and places text labels indicating the strength of correlation in appropriate positions within the facets.

An object of class Layer.

lotri_corrtext() and utri_corrtext()

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