add_heatmap: Correlation heatmaps in ggcorrm plots.

Description Usage Arguments Details Value See Also

Description

lotri_heatmap() and utri_heatmap() are used to display correlation heatmaps in the lower/upper off-diagonal facets of ggcorrm plots. lotri_heatpoint() and utri_heatpoint() scale the and colour of a single centered geom_point() by correlation strength.

Usage

1
2
3
4
5
6
7
lotri_heatmap(corr_method = NULL, ...)

utri_heatmap(corr_method = NULL, ...)

lotri_heatpoint(corr_size = TRUE, mapping = NULL, corr_method = NULL, ...)

utri_heatpoint(corr_size = TRUE, mapping = NULL, corr_method = NULL, ...)

Arguments

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

corr_size

logical - should the size aesthetic of the points in lotri/utri_heatpoint() be expressed as a function of correlation strength? corr_size = TRUE Defaults to 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).

Details

lotri_/utri_heatmap() can be used to display correlation heat maps in the facets of ggcorrm plots.

lotri/utri_heatmap() are a wrapper around stat_heatmap() that additionally take care of the right specification of aesthetics.

lotri/utri_heatpoint() instead plots points positioned as in stat_corrtext() whose size on default depends on the strength of correlation. The shape parameter as well as transparency etc. can be adjusted via the ... argument. The range of sizes covered by the 'heatpoints' can be adjusted by scale_size().

Value

A ggplot2 layer with correlation heatmaps / points indicating correlation strength.

See Also

stat_heatmap(), stat_heatcircle(), geom_relpoint()


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