ggdotplotstats
Dot plot/chart for labeled numeric data.
A dot chart with statistical details from one-sample test included in the plot as a subtitle.
Usage
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)Arguments
- data
A dataframe (or a tibble) from which variables specified are to be taken. A matrix or tables will not be accepted.
- x
A numeric variable.
- y
Label or grouping variable.
- xlab
Labels for
xandyaxis variables. IfNULL(default), variable names forxandywill be used.- ylab
Label for
yaxis variable.- title
The text for the plot title.
- stat.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 astat.titleargument will be something like"Student's t-test: ".- subtitle
The text for the plot subtitle. Will work only if
results.subtitle = FALSE.- caption
The text for the plot caption.
- type
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.- test.value
A number specifying the value of the null hypothesis (Default:
0).- bf.prior
A number between
0.5and2(default0.707), the prior width to use in calculating Bayes factors.- bf.message
Logical that decides whether to display Bayes Factor in favor of the null hypothesis. This argument is relevant only for parametric test (Default:
TRUE).- robust.estimator
If
test = "robust"robust estimator to be used ("onestep"(Default),"mom", or"median"). For more, see?WRS2::onesampb.- effsize.type
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- effsize.noncentral
Logical indicating whether to use non-central t-distributions for computing the confidence interval for Cohen's d or Hedge's g (Default:
TRUE).- conf.level
Scalar between 0 and 1. If unspecified, the defaults return
95%lower and upper confidence intervals (0.95).- nboot
Number of bootstrap samples for computing confidence interval for the effect size (Default:
100).- k
Number of digits after decimal point (should be an integer) (Default:
k = 2).- results.subtitle
Decides whether the results of statistical tests are to be displayed as a subtitle (Default:
TRUE). If set toFALSE, only the plot will be returned.- ggtheme
A function,
ggplot2theme name. Default value isggplot2::theme_bw(). Any of theggplot2themes, or themes from extension packages are allowed (e.g.,ggthemes::theme_fivethirtyeight(),hrbrthemes::theme_ipsum_ps(), etc.).- ggstatsplot.layer
Logical that decides whether
theme_ggstatsplottheme elements are to be displayed along with the selectedggtheme(Default:TRUE).- point.color
Character describing color for the point (Default:
"black").- point.size
Numeric specifying size for the point (Default:
3).- point.shape
Numeric specifying shape to draw the points (Default:
16(a dot)).- centrality.para
Decides which measure of central tendency (
"mean"or"median") is to be displayed as a vertical line.- centrality.color
Decides color for the vertical line for centrality parameter (Default:
"blue").- centrality.size
Decides size for the vertical line for centrality parameter (Default:
1.2).- centrality.linetype
Decides linetype for the vertical line for centrality parameter (Default:
"dashed").- centrality.line.labeller
A logical that decides whether line labels should be displayed for the centrality.para line (Default:
TRUE).- centrality.k
Integer denoting the number of decimal places expected for centrality parameter label. (Default:
2).- test.value.line
Decides whether test value is to be displayed as a vertical line (Default:
FALSE).- test.value.color
Decides color for the vertical line denoting test value (Default:
"black").- test.value.size
Decides size for the vertical line for test value (Default:
1.2).- test.value.linetype
Decides linetype for the vertical line for test value (Default:
"dashed").- test.line.labeller
A logical that decides whether line labels should be displayed for test.value line (Default:
TRUE).- test.k
Integer denoting the number of decimal places expected for
test.valuelabel. (Default:0).- ggplot.component
A
ggplotcomponent to be added to the plot prepared byggstatsplot. This argument is primarily helpful forgrouped_variant of the current function. Default isNULL. The argument should be entered as a function. If the given function has an argumentaxes.range.restrictand if it has been set toTRUE, the added ggplot component might not work as expected.- return
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, which will be aNULLif you setresults.subtitle = FALSE. Setting this to"caption"will return the expression containing details about Bayes Factor analysis, but valid only whentype = "p"andbf.message = TRUE, otherwise this will return aNULL.- messages
Decides whether messages references, notes, and warnings are to be displayed (Default:
TRUE).
See Also
Examples
# 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")
)
)
# }