A dot chart with statistical details from one-sample test included in the plot as a subtitle.
ggdotplotstats(
data,
x,
y,
xlab = NULL,
ylab = NULL,
title = NULL,
stat.title = NULL,
subtitle = NULL,
caption = NULL,
type = "parametric",
test.value = 0,
bf.prior = 0.707,
bf.message = TRUE,
robust.estimator = "onestep",
effsize.type = "g",
effsize.noncentral = TRUE,
conf.level = 0.95,
nboot = 100,
k = 2,
results.subtitle = TRUE,
ggtheme = ggplot2::theme_bw(),
ggstatsplot.layer = TRUE,
point.color = "black",
point.size = 3,
point.shape = 16,
centrality.para = "mean",
centrality.color = "blue",
centrality.size = 1,
centrality.linetype = "dashed",
centrality.line.labeller = TRUE,
centrality.k = 2,
test.value.line = FALSE,
test.value.color = "black",
test.value.size = 1,
test.value.linetype = "dashed",
test.line.labeller = TRUE,
test.k = 0,
ggplot.component = NULL,
return = "plot",
messages = TRUE
)
A dataframe (or a tibble) from which variables specified are to be taken. A matrix or tables will not be accepted.
A numeric variable.
Label or grouping variable.
Labels for x
and y
axis variables. If NULL
(default),
variable names for x
and y
will be used.
Label for y
axis variable (Default: "term"
).
The text for the plot title.
A character describing the test being run, which will be
added as a prefix in the subtitle. The default is NULL
. An example of a
stat.title
argument will be something like "Student's t-test: "
.
The text for the plot subtitle. Will work only if
results.subtitle = FALSE
.
The text for the plot caption.
Type of statistic expected ("parametric"
or "nonparametric"
or "robust"
or "bayes"
).Corresponding abbreviations are also accepted:
"p"
(for parametric), "np"
(nonparametric), "r"
(robust), or
"bf"
resp.
A number specifying the value of the null hypothesis
(Default: 0
).
A numeric value between 0.5
and 2
(default 0.707
), the
prior width to use in calculating Bayes Factors.
Logical that decides whether to display Bayes Factor in
favor of the null hypothesis. This argument is relevant only for
parametric test (Default: TRUE
).
If type = "robust"
, a robust estimator to be used
("onestep"
(Default), "mom"
, or "median"
). For more, see
?WRS2::onesampb
.
Type of effect size needed for parametric tests. The
argument can be "biased"
("d"
for Cohen's d) or "unbiased"
("g"
Hedge's g for t-test). The default is "g"
.
Logical indicating whether to use non-central
t-distributions for computing the confidence interval for Cohen's d
or Hedge's g (Default: TRUE
).
Scalar between 0 and 1. If unspecified, the defaults return
95%
lower and upper confidence intervals (0.95
).
Number of bootstrap samples for computing confidence interval
for the effect size (Default: 100
).
Number of digits after decimal point (should be an integer)
(Default: k = 2
).
Decides whether the results of statistical tests are
to be displayed as a subtitle (Default: TRUE
). If set to FALSE
, only
the plot will be returned.
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.).
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
.
Character describing color for the point (Default:
"black"
).
Numeric specifying size for the point (Default: 3
).
Numeric specifying shape to draw the points (Default: 16
(a dot)).
Decides which measure of central tendency ("mean"
or "median"
) is to be displayed as a vertical line.
Decides color for the vertical line for centrality
parameter (Default: "blue"
).
Decides size for the vertical line for centrality
parameter (Default: 1.2
).
Decides linetype for the vertical line for
centrality parameter (Default: "dashed"
).
A logical that decides whether line labels
should be displayed for the centrality.para line (Default: TRUE
).
Integer denoting the number of decimal places expected
for centrality parameter label. (Default: 2
).
Decides whether test value is to be displayed as a
vertical line (Default: FALSE
).
Decides color for the vertical line denoting test
value (Default: "black"
).
Decides size for the vertical line for test value
(Default: 1.2
).
Decides linetype for the vertical line for test
value (Default: "dashed"
).
A logical that decides whether line labels should
be displayed for test.value line (Default: TRUE
).
Integer denoting the number of decimal places expected for
test.value
label. (Default: 0
).
A ggplot
component to be added to the plot prepared
by ggstatsplot
. This argument is primarily helpful for grouped_
variant
of the current function. Default is NULL
. The argument should be entered
as a function. If the given function has an argument axes.range.restrict
and if it has been set to TRUE
, the added ggplot
component might not
work as expected.
Character that describes what is to be returned: can be
"plot"
(default) or "subtitle"
or "caption"
. Setting this to
"subtitle"
will return the expression containing statistical results. If
you have set results.subtitle = FALSE
, then this will return a NULL
.
Setting this to "caption"
will return the expression containing details
about Bayes Factor analysis, but valid only when type = "parametric"
and
bf.message = TRUE
, otherwise this will return a NULL
.
Decides whether messages references, notes, and warnings are
to be displayed (Default: TRUE
).
https://indrajeetpatil.github.io/ggstatsplot/articles/web_only/ggdotplotstats.html
# NOT RUN {
# for reproducibility
set.seed(123)
# plot
ggdotplotstats(
data = ggplot2::mpg,
x = cty,
y = manufacturer,
conf.level = 0.99,
test.value = 15,
test.value.line = TRUE,
test.line.labeller = TRUE,
test.value.color = "red",
centrality.para = "median",
centrality.k = 0,
title = "Fuel economy data",
xlab = "city miles per gallon",
caption = substitute(
paste(italic("Source"), ": EPA dataset on http://fueleconomy.gov")
)
)
# }
Run the code above in your browser using DataCamp Workspace