Plot correlation matrix as ellipses or tiles.
Usage
sjp.corr(
data,
title = NULL,
axis.labels = NULL,
sort.corr = TRUE,
decimals = 3,
na.deletion = c("listwise", "pairwise"),
corr.method = c("pearson", "spearman", "kendall"),
geom.colors = "RdBu",
wrap.title = 50,
wrap.labels = 20,
show.legend = FALSE,
legend.title = NULL,
show.values = TRUE,
show.p = TRUE,
p.numeric = FALSE
)
Arguments
- data
Matrix with correlation coefficients as returned by the
cor
-function, or adata.frame
of variables where correlations between columns should be computed.- title
character vector, used as plot title. Depending on plot type and function, will be set automatically. If
title = ""
, no title is printed. For effect-plots, may also be a character vector of length > 1, to define titles for each sub-plot or facet.- axis.labels
character vector with labels used as axis labels. Optional argument, since in most cases, axis labels are set automatically.
- sort.corr
Logical, if
TRUE
(default), the axis labels are sorted according to the correlation strength. IfFALSE
, axis labels appear in order of how variables were included in the cor-computation or data frame.- decimals
Indicates how many decimal values after comma are printed when the values labels are shown. Default is 3. Only applies when
show.values = TRUE
.- na.deletion
Indicates how missing values are treated. May be either
"listwise"
(default) or"pairwise"
. May be abbreviated.- corr.method
Indicates the correlation computation method. May be one of
"pearson"
(default),"spearman"
or"kendall"
. May be abbreviated.- geom.colors
user defined color for geoms. See 'Details' in
plot_grpfrq
.- wrap.title
numeric, determines how many chars of the plot title are displayed in one line and when a line break is inserted.
- wrap.labels
numeric, determines how many chars of the value, variable or axis labels are displayed in one line and when a line break is inserted.
- show.legend
logical, if
TRUE
, and depending on plot type and function, a legend is added to the plot.- legend.title
character vector, used as title for the plot legend.
- show.values
Logical, whether values should be plotted or not.
- show.p
Logical, adds significance levels to values, or value and variable labels.
- p.numeric
Logical, if
TRUE
, the p-values are printed as numbers. IfFALSE
(default), asterisks are used.
Value
(Insisibily) returns the ggplot-object with the complete plot (plot
) as well as the data frame that
was used for setting up the ggplot-object (df
) and the original correlation matrix
(corr.matrix
).
Details
Required argument is either a data.frame
or a matrix with correlation coefficients
as returned by the cor
-function. In case of ellipses, the
ellipses size indicates the strength of the correlation. Furthermore,
blue and red colors indicate positive or negative correlations, where
stronger correlations are darker.
Note
If data
is a matrix with correlation coefficients as returned by
the cor
-function, p-values can't be computed.
Thus, show.p
and p.numeric
only have an effect if data
is a data.frame
.