cor.vars.names
-
Optional list of names to be used for cor.vars
. The
names should be entered in the same order.
partial
-
Can be TRUE
for partial correlations. For Bayesian partial
correlations, "full" instead of pseudo-Bayesian partial correlations (i.e.,
Bayesian correlation based on frequentist partialization) are returned.
matrix.type
-
Character, "upper"
(default), "lower"
, or "full"
,
display full matrix, lower triangular or upper triangular matrix.
sig.level
-
Significance level (Default: 0.05
). If the p-value in
p-value matrix is bigger than sig.level
, then the corresponding
correlation coefficient is regarded as insignificant and flagged as such in
the plot. Relevant only when output = "plot"
.
colors
-
A vector of 3 colors for low, mid, and high correlation values.
If set to NULL
, manual specification of colors will be turned off and 3
colors from the specified palette
from package
will be selected.
pch
-
Decides the point shape to be used for insignificant correlation
coefficients (only valid when insig = "pch"
). Default: pch = "cross"
.
ggcorrplot.args
-
A list of additional (mostly aesthetic) arguments that
will be passed to ggcorrplot::ggcorrplot
function. The list should avoid
any of the following arguments since they are already internally being
used: corr
, method
, p.mat
, sig.level
, ggtheme
, colors
, lab
,
pch
, legend.title
, digits
.
type
-
A character specifying the type of statistical approach.
Four possible options:
-
"parametric"
-
"nonparametric"
-
"robust"
-
"bayes"
Corresponding abbreviations are also accepted: "p"
(for parametric),
"np"
(for nonparametric), "r"
(for robust), or "bf"
(for Bayesian).
tr
-
Trim level for the mean when carrying out robust
tests. In case
of an error, try reducing the value of tr
, which is by default set to
0.2
. Lowering the value might help.
k
-
Number of digits after decimal point (should be an integer)
(Default: k = 2L
).
conf.level
-
Scalar between 0
and 1
. If unspecified, the defaults
return 95%
confidence/credible intervals (0.95
).
bf.prior
-
A number between 0.5
and 2
(default 0.707
), the prior
width to use in calculating Bayes factors and posterior estimates.
p.adjust.method
-
Adjustment method for p-values for multiple
comparisons. Possible methods are: "holm"
(default), "hochberg"
,
"hommel"
, "bonferroni"
, "BH"
, "BY"
, "fdr"
, "none"
.
package
-
Name of the package from which the given palette is to
be extracted. The available palettes and packages can be checked by running
View(paletteer::palettes_d_names)
.
palette
-
Name of the package from which the given palette is to
be extracted. The available palettes and packages can be checked by running
View(paletteer::palettes_d_names)
.
ggtheme
-
A function, ggplot2
theme name. Default value is
ggplot2::theme_bw()
. Any of the ggplot2
themes, or themes from
extension packages are allowed (e.g., ggthemes::theme_fivethirtyeight()
,
hrbrthemes::theme_ipsum_ps()
, etc.).
ggstatsplot.layer
-
Logical that decides whether theme_ggstatsplot
theme elements are to be displayed along with the selected ggtheme
(Default: TRUE
). theme_ggstatsplot
is an opinionated theme layer that
override some aspects of the selected ggtheme
.
ggplot.component
-
A ggplot
component to be added to the plot prepared
by ggstatsplot
. This argument is primarily helpful for grouped_
variants of all primary functions. Default is NULL
. The argument should
be entered as a ggplot2
function or a list of ggplot2
functions.
subtitle
-
The text for the plot subtitle. Will work only if
results.subtitle = FALSE
.
caption
-
The text for the plot caption.