A dot chart (as described by William S. Cleveland) with statistical details from one-sample test included in the plot as a subtitle.
ggdotplotstats(
data,
x,
y,
xlab = NULL,
ylab = NULL,
title = NULL,
subtitle = NULL,
caption = NULL,
type = "parametric",
test.value = 0,
bf.prior = 0.707,
bf.message = TRUE,
effsize.type = "g",
conf.level = 0.95,
nboot = 100,
k = 2,
results.subtitle = TRUE,
point.args = list(color = "black", size = 3, shape = 16),
test.k = 0,
test.value.line = FALSE,
test.value.line.args = list(size = 1),
test.value.label.args = list(size = 3),
centrality.parameter = "mean",
centrality.k = 2,
centrality.line.args = list(color = "blue", size = 1),
centrality.label.args = list(color = "blue", size = 3),
ggplot.component = NULL,
ggtheme = ggplot2::theme_bw(),
ggstatsplot.layer = TRUE,
output = "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 from the dataframe data.
Label or grouping variable.
Labels for x and y axis variables. If NULL (default),
variable names for x and y will be used.
Labels for x- and y- axis variables, respectively
(Defaults: "regression coefficient" and "term").
The text for the plot title.
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 number 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).
Type of effect size needed for parametric tests. The
argument can be "d" (for Cohen's d) or "g" (for Hedge's g).
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 list of additional aesthetic arguments passed to
geom_point.
Integer denoting the number of decimal places expected for
test.value label. (Default: 0 ).
Logical that decides whether a line corresponding to
the test.value should be superimposed on the plot.
A list of additional
aesthetic arguments to be passed to the geom_line used to display the
lines corresponding to the centrality parameter and test value.
A list of additional
aesthetic arguments to be passed to the geom_label used to display the
label corresponding to the centrality parameter and test value.
Decides which measure of central tendency
("mean" or "median") is to be displayed as a vertical line. To not show
any parameter, set this to "none".
Integer denoting the number of decimal places expected
for centrality parameter label. (Default: 2).
A list of additional
aesthetic arguments to be passed to the geom_line used to display the
lines corresponding to the centrality parameter and test value.
A list of additional
aesthetic arguments to be passed to the geom_label used to display the
label corresponding to the centrality parameter and test value.
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.
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 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. For functions
ggpiestats and ggbarstats, setting output = "proptest" will return a
dataframe containing results from proportion tests.
Decides whether messages references, notes, and warnings are
to be displayed (Default: TRUE).
Currently ignored.
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,
centrality.parameter = "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 DataLab