grouped_ggdotplotstats
Grouped histograms for distribution of a labeled numeric variable
Helper function for ggstatsplot::ggdotplotstats to apply this
function across multiple levels of a given factor and combining the
resulting plots using ggstatsplot::combine_plots.
Usage
grouped_ggdotplotstats(
data,
x,
y,
grouping.var,
title.prefix = NULL,
output = "plot",
...,
plotgrid.args = list(),
title.text = NULL,
title.args = list(size = 16, fontface = "bold"),
caption.text = NULL,
caption.args = list(size = 10),
sub.text = NULL,
sub.args = list(size = 12)
)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 from the dataframe
data.- y
Label or grouping variable.
- grouping.var
A single grouping variable (can be entered either as a bare name
xor as a string"x").- title.prefix
Character string specifying the prefix text for the fixed plot title (name of each factor level) (Default:
NULL). IfNULL, the variable name entered forgrouping.varwill be used.- output
If
"expression", will return expression with statistical details, while"dataframe"will return a dataframe containing the results.- ...
Arguments passed on to
ggdotplotstatspoint.argsA list of additional aesthetic arguments passed to
geom_point.test.valueA number specifying the value of the null hypothesis (Default:
0).test.kInteger denoting the number of decimal places expected for
test.valuelabel. (Default:0).test.value.lineLogical that decides whether a line corresponding to the
test.valueshould be superimposed on the plot.test.value.line.argsA list of additional aesthetic arguments to be passed to the
geom_lineused to display the lines corresponding to the centrality parameter and test value.test.value.label.argsA list of additional aesthetic arguments to be passed to the
geom_labelused to display the label corresponding to the centrality parameter and test value.centrality.parameterDecides 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".centrality.kInteger denoting the number of decimal places expected for centrality parameter label. (Default:
2).centrality.line.argsA list of additional aesthetic arguments to be passed to the
geom_lineused to display the lines corresponding to the centrality parameter and test value.centrality.label.argsA list of additional aesthetic arguments to be passed to the
geom_labelused to display the label corresponding to the centrality parameter and test value.xlabLabels for
xandyaxis variables. IfNULL(default), variable names forxandywill be used.subtitleThe text for the plot subtitle. Will work only if
results.subtitle = FALSE.captionThe text for the plot caption.
typeType 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.bf.priorA number between
0.5and2(default0.707), the prior width to use in calculating Bayes factors.bf.messageLogical that decides whether to display Bayes Factor in favor of the null hypothesis. This argument is relevant only for parametric test (Default:
TRUE).effsize.typeType of effect size needed for parametric tests. The argument can be
"d"(for Cohen's d) or"g"(for Hedge's g).conf.levelScalar between 0 and 1. If unspecified, the defaults return
95%confidence/credible intervals (0.95).nbootNumber of bootstrap samples for computing confidence interval for the effect size (Default:
100).kNumber of digits after decimal point (should be an integer) (Default:
k = 2L).results.subtitleDecides whether the results of statistical tests are to be displayed as a subtitle (Default:
TRUE). If set toFALSE, only the plot will be returned.ggplot.componentA
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.ggthemeA 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.layerLogical that decides whether
theme_ggstatsplottheme elements are to be displayed along with the selectedggtheme(Default:TRUE).theme_ggstatsplotis an opinionated theme layer that override some aspects of the selectedggtheme.ylabLabels for
x- andy- axis variables, respectively (Defaults:"regression coefficient"and"term").
- plotgrid.args
A list of additional arguments to
cowplot::plot_grid.- title.text
String or plotmath expression to be drawn as title for the combined plot.
- title.args
A list of additional arguments provided to
title,captionandsub, resp.- caption.text
String or plotmath expression to be drawn as the caption for the combined plot.
- caption.args
A list of additional arguments provided to
title,captionandsub, resp.- sub.text
The label with which the combined plot should be annotated. Can be a plotmath expression.
- sub.args
A list of additional arguments provided to
title,captionandsub, resp.
References
https://indrajeetpatil.github.io/ggstatsplot/articles/web_only/ggdotplotstats.html
See Also
Examples
# NOT RUN {
# for reproducibility
set.seed(123)
# removing factor level with very few no. of observations
df <- dplyr::filter(.data = ggplot2::mpg, cyl %in% c("4", "6", "8"))
# plot
ggstatsplot::grouped_ggdotplotstats(
data = df,
x = "cty",
y = "manufacturer",
grouping.var = "cyl",
test.value = 15.5,
title.prefix = "cylinder count",
ggplot.component = ggplot2::scale_x_continuous(
sec.axis = ggplot2::dup_axis(),
limits = c(12, 24),
breaks = seq(12, 24, 2)
),
messages = FALSE
)
# }