cormatrix_excel: Easy export of correlation matrix to Excel

In RemPsyc/rempsyc: Convenience Functions for Psychology

Easy export of correlation matrix to Excel

Description

Easily output a correlation matrix and export it to Microsoft Excel, with the first row and column frozen, and correlation coefficients colour-coded based on effect size (0.0-0.2: small (no colour); 0.2-0.4: medium (pink/light blue); 0.4-1.0: large (red/dark blue)), following Cohen's suggestions for small (.10), medium (.30), and large (.50) correlation sizes.

Based on the correlation and openxlsx2 packages.

Usage

cormatrix_excel(
  data,
  filename,
  overwrite = TRUE,
  p_adjust = "none",
  print.mat = TRUE,
  ...
)

Arguments

data	The data frame
filename	Desired filename (path can be added before hand but no need to specify extension).
overwrite	Whether to allow overwriting previous file.
p_adjust	Default p-value adjustment method (default is "none", although correlation::correlation()'s default is "holm")
print.mat	Logical, whether to also print the correlation matrix to console.
...	Parameters to be passed to the correlation package (see correlation::correlation())

Details

For the easystats equivalent, see: correlation::cormatrix_to_excel().

Value

A Microsoft Excel document, containing the colour-coded correlation matrix with significance stars, on the first sheet, and the colour-coded p-values on the second sheet.

Author(s)

Adapted from @JanMarvin (JanMarvin/openxlsx2#286) and the original cormatrix_excel (now imported from correlation::cormatrix_to_excel).

Examples

# Basic example
cormatrix_excel(mtcars, select = c("mpg", "cyl", "disp", "hp", "carb"), filename = "cormatrix1")
cormatrix_excel(iris, p_adjust = "none", filename = "cormatrix2")
cormatrix_excel(airquality, method = "spearman", filename = "cormatrix3")

RemPsyc/rempsyc documentation built on Feb. 14, 2025, 8:38 a.m.