Visualization of a correlalogram (or correlation matrix) using 'ggplot2'/'ggcorrplot'
ggcorrmat(data, cor.vars, cor.vars.names = NULL, output = "plot",
type = "full", method = "square", corr.method = "pearson",
exact = FALSE, continuity = TRUE, beta = 0.1, digits = 2,
sig.level = 0.05, hc.order = FALSE, hc.method = "complete",
lab = TRUE, colors = c("#E69F00", "white", "#009E73"),
outline.color = "black", ggtheme = ggplot2::theme_bw,
ggstatsplot.theme = TRUE, title = NULL, subtitle = NULL,
caption = NULL, caption.default = TRUE, lab.col = "black",
lab.size = 5, insig = "pch", pch = 4, pch.col = "black",
pch.cex = 11, tl.cex = 12, tl.col = "black", tl.srt = 45,
axis.text.x.margin.t = 0, axis.text.x.margin.r = 0,
axis.text.x.margin.b = 0, axis.text.x.margin.l = 0,
legend.title.margin = FALSE, t.margin = unit(0, "mm"),
b.margin = unit(3, "mm"), messages = TRUE)Dataframe from which variables specified are preferentially to be taken.
List of variables for which the correlation matrix is to be computed and visualized.
Optional list of names to be used for cor.vars. The
names should be entered in the same order.
Expected output from this function: "plot" (visualization
matrix) or "correlations" (correlation matrix) or "p-values" (matrix of
p-values).
Character, "full" (default), "upper" or "lower", display
full matrix, lower triangular or upper triangular matrix.
Character argument that decides the visualization method of
correlation matrix to be used. Allowed values are "square" (default),
"circle"
A character string indicating which correlation
coefficient is to be computed ("pearson" (default) or "kendall" or
"spearman"). "robust" can also be entered but only if output argument
is set to either "correlations" or "p-values". The robust correlation
used is percentage bend correlation (see ?WRS2::pball). Abbreviations
will not work.
A logical indicating whether an exact p-value should be
computed. Used for Kendall's tau and Spearman's rho. For more details,
see ?stats::cor.test.
A logical. If TRUE, a continuity correction is used for
Kendall's tau and Spearman's rho when not computed exactly (Default:
TRUE).
A numeric bending constant for robust correlation coefficient
(Default: 0.1).
Decides the number of decimal digits to be added into the plot
(Default: 2).
Significance level (Default: 0.05). If the p-value in
p-mat (p-value matrix) is bigger than sig.level, then the corresponding
correlation coefficient is regarded as insignificant.
Logical value. If TRUE, correlation matrix will be
hc.ordered using hclust function (Default is FALSE).
The agglomeration method to be used in hclust (see
?hclust).
Logical value. If TRUE, correlation coefficient values will be
displayed in the plot.
A vector of 3 colors for low, mid, and high correlation values.
The outline color of square or circle. Default value is
"gray".
A function, ggplot2 theme name. Default value is
ggplot2::theme_bw. Allowed values are the official ggplot2 themes,
including theme_grey, theme_minimal, theme_classic, theme_void, etc.
A logical. Decides whether default theme for
ggstatsplot, which is theme_mprl, is to be overlaid on the entered
theme (Default: ggstatsplot.theme = TRUE).
The text for the plot title.
The text for the plot subtitle.
The text for the plot caption. If not specified (if it is
NULL, i.e.), a default caption will be shown.
Logical decides whether the default caption should be shown.
Color to be used for the correlation coefficient labels
(applicable only when lab = TRUE).
Size to be used for the correlation coefficient labels
(applicable only when lab = TRUE).
Character used to show specialized insignificant correlation
coefficients ("pch" (default) or "blank"). If "blank", the
corresponding glyphs will be removed; if "pch" is used, characters (see
?pch for details) will be added on the corresponding glyphs.
Decides the glyphs (read point shapes) to be used for insignificant correlation
coefficients (only valid when insig = "pch"). Default value is pch = 4.
The color and the cex (size) of pch (only valid when
insig = "pch"). Defaults are pch.col = "#F0E442" and pch.cex = 10.
The size, the color, and the string rotation of text label (variable names, i.e.).
Margins between x-axis and the variable name texts (t: top, r: right, b:
bottom, l:left), especially useful in case the names are slanted, i.e. when the tl.srt is
between 45 and 75 (Defaults: 0, 0, 0, 0, resp.).
Logical indicating whether to adjust the margin between legend title and the
colorbar (Default: FALSE).
Margins in grid units. For more details, see
?grid::unit().
Decides whether messages references, notes, and warnings are
to be displayed (Default: TRUE).
Correlation matrix plot or correlation coefficient matrix or matrix of p-values.
https://indrajeetpatil.github.io/ggstatsplot/articles/ggcorrmat.html
# NOT RUN {
# to get the correlalogram
ggstatsplot::ggcorrmat(
data = datasets::iris,
cor.vars = c(Sepal.Length:Petal.Width)
)
# to get the correlation matrix
ggstatsplot::ggcorrmat(
data = datasets::iris,
cor.vars = c(Sepal.Length:Petal.Width),
output = "correlations"
)
# setting output = "p-values" will return the p-value matrix
# modifying few elements of the correlation matrix by changing function defaults
ggstatsplot::ggcorrmat(
data = datasets::iris,
cor.vars = c(Sepal.Length, Sepal.Width, Petal.Length, Petal.Width),
sig.level = 0.01,
ggtheme = ggplot2::theme_bw,
hc.order = TRUE, type = "lower", outline.col = "white",
title = "Dataset: Iris"
)
# }
Run the code above in your browser using DataCamp Workspace