Helper function for ggstatsplot::gghistostats to apply this
function across multiple levels of a given factor and combining the
resulting plots using ggstatsplot::combine_plots.
grouped_gghistostats(
data,
x,
grouping.var,
binwidth = NULL,
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)
)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.
A single grouping variable (can be entered either as a
bare name x or as a string "x").
The width of the histogram bins. Can be specified as a
numeric value, or a function that calculates width from x. The default is
to use the max(x) - min(x) / sqrt(N). You should always check this value
and explore multiple widths to find the best to illustrate the stories in
your data.
Character string specifying the prefix text for the fixed
plot title (name of each factor level) (Default: NULL). If NULL, the
variable name entered for grouping.var will be used.
If "expression", will return expression with statistical
details, while "dataframe" will return a dataframe containing the
results.
Arguments passed on to gghistostats
bar.measureCharacter describing what value needs to be represented as
height in the bar chart. This can either be "count", which shows number
of points in bin, or "density", which density of points in bin, scaled to
integrate to 1, or "proportion", which shows relative frequencies of
observations in each bin, or "mix", which shows both count and
proportion in the same plot.
normal.curveA logical value that decides whether to super-impose a
normal curve using stats::dnorm(mean(x), sd(x)). Default is FALSE.
normal.curve.argsA list of additional aesthetic arguments to be passed to the normal curve.
bar.fillCharacter input that decides which color will uniformly fill
all the bars in the histogram (Default: "grey50").
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.
test.valueA number specifying the value of the null hypothesis
(Default: 0).
bf.priorA number between 0.5 and 2 (default 0.707), the prior
width to use in calculating Bayes factors.
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).
test.kInteger denoting the number of decimal places expected for
test.value label. (Default: 0 ).
test.value.lineLogical that decides whether a line corresponding to
the test.value should be superimposed on the plot.
test.value.line.argsA 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.
test.value.label.argsA 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.
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_line used 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_label used to display the
label corresponding to the centrality parameter and test value.
xlabLabels for x and y axis variables. If NULL (default),
variable names for x and y will be used.
subtitleThe text for the plot subtitle. Will work only if
results.subtitle = FALSE.
captionThe text for the plot caption.
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).
ggthemeA 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.layerLogical 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.
results.subtitleDecides 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.
ggplot.componentA 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 list of additional arguments to cowplot::plot_grid.
String or plotmath expression to be drawn as title for the combined plot.
A list of additional arguments
provided to title, caption and sub, resp.
String or plotmath expression to be drawn as the caption for the combined plot.
A list of additional arguments
provided to title, caption and sub, resp.
The label with which the combined plot should be annotated. Can be a plotmath expression.
A list of additional arguments
provided to title, caption and sub, resp.
https://indrajeetpatil.github.io/ggstatsplot/articles/web_only/gghistostats.html
# NOT RUN {
# for reproducibility
set.seed(123)
# plot
ggstatsplot::grouped_gghistostats(
data = iris,
x = Sepal.Length,
test.value = 5,
grouping.var = Species,
bar.fill = "orange",
ggplot.component = list(
ggplot2::scale_x_continuous(breaks = seq(3, 9, 1), limits = (c(3, 9))),
ggplot2::scale_y_continuous(breaks = seq(0, 25, 5), limits = (c(0, 25)))
),
messages = FALSE,
plotgrid.args = list(nrow = 1, labels = c("(i)", "(ii)", "(iii)")),
)
# }
Run the code above in your browser using DataLab