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, title.prefix = "Group",
binwidth = NULL, bar.measure = "count", xlab = NULL,
title = NULL, subtitle = NULL, caption = NULL,
type = "parametric", test.value = 0, bf.prior = 0.707,
bf.message = FALSE, robust.estimator = "onestep", nboot = 500,
k = 3, ggtheme = ggplot2::theme_bw(), ggstatsplot.layer = TRUE,
fill.gradient = FALSE, low.color = "#0072B2",
high.color = "#D55E00", bar.fill = "grey50",
results.subtitle = TRUE, 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, messages = TRUE, ...)Dataframe from which variables specified are preferentially to be taken. This argument is optional.
A numeric variable.
Grouping variable.
Character specifying the prefix text for the fixed plot
title (name of each factor level) (Default: "Group").
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 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 (only available from ggplot2 3.0.1 onward).
Label for x axis variable.
The text for the plot title.
The text for the plot subtitle if you don't want results
from one sample test to be displayed (i.e. results.subtitle should be set
to FALSE).
The text for the plot caption.
Type of statistic expected ("parametric" or "nonparametric"
or "robust" or "bayes"). Abbreviations accepted are "p" or "np" or
"r" or "bf", respectively.
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. Decides whether to display Bayes Factor in favor
of null hypothesis for parametric test (Default: bf.message = FALSE).
This will work only if results.subtitle = TRUE.
If test = "robust" robust estimator to be used
("onestep" (Default), "mom", or "median"). For more, see
?WRS2::onesampb.
Number of bootstrap samples for robust one-sample location test
(Default: 100).
Number of digits after decimal point (should be an integer) (Default: k = 3).
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_economist(),
hrbrthemes::theme_ipsum_ps(), ggthemes::theme_fivethirtyeight(), etc.).
Logical that decides whether theme_ggstatsplot
theme elements are to be displayed along with the selected ggtheme
(Default: TRUE).
Logical decides whether color fill gradient is to be
displayed (Default: FALSE). If FALSE, the legend and the color gradient
will also be removed. The default is set to FALSE because the gradient
provides redundant information in light of y-axis labels.
Colors for low and high ends of the gradient. Defaults are colorblind-friendly.
Colors for low and high ends of the gradient. Defaults are colorblind-friendly.
If fill.gradient = FALSE, then bar.fill decides which
color will uniformly fill all the bars in the histogram (Default: "grey50").
Decides whether the results of statistical tests are
to be displayed as subtitle (Default: results.subtitle = TRUE). If set to
FALSE, no statistical tests will be run.
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 (Default: TRUE).
Integer denoting the number of decimal places
expected for test and centrality parameters. (Default: 0 and 2,
respectively).
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 (Default: TRUE).
Integer denoting the number of decimal places
expected for test and centrality parameters. (Default: 0 and 2,
respectively).
Decides whether messages references, notes, and warnings are
to be displayed (Default: TRUE).
Arguments passed on to combine_plots
String or plotmath expression to be drawn as title for the combined plot.
Text color for title.
Point size of title text.
Vertical justification for title. Default = 0.5 (centered
on y). 0 = baseline at y, 1 = ascender at y.
Horizontal justification for title. Default = 0.5
(centered on x). 0 = flush-left at x, 1 = flush-right.
The font face ("plain", "bold" (default), "italic",
"bold.italic") for title.
String or plotmath expression to be drawn as the caption for the combined plot.
Text color for caption.
Point size of title text.
Vertical justification for caption. Default = 0.5
(centered on y). 0 = baseline at y, 1 = ascender at y.
Horizontal justification for caption. Default = 0.5
(centered on x). 0 = flush-left at x, 1 = flush-right.
The font face ("plain" (default), "bold", "italic",
"bold.italic") for caption.
The label with which the combined plot should be annotated. Can be a plotmath expression.
Text color for annotation label (Default: "black").
Point size of annotation text (Default: 12).
The x position of annotation label (Default: 0.5).
The y position of annotation label (Default: 0.5).
Horizontal justification for annotation label (Default:
0.5).
Vertical justification for annotation label (Default:
0.5).
Vertical padding. The total vertical space added to the
label, given in grid units. By default, this is added equally above and
below the label. However, by changing the y and vjust parameters, this can
be changed (Default: grid::unit(1, "lines")).
The font face ("plain" (default), "bold", "italic",
"bold.italic") for the annotation label.
Angle at which annotation label is to be drawn (Default:
0).
Line height of annotation label.
Numerical vector of relative columns heights while combining (title, plot, caption).
Numerical vector of relative columns heights while combining (title, plot).
Numerical vector of relative columns heights while combining (plot, caption).
https://cran.r-project.org/package=ggstatsplot/vignettes/gghistostats.html
# NOT RUN {
ggstatsplot::grouped_gghistostats(
data = iris,
x = Sepal.Length,
test.value = 5,
bf.message = TRUE,
grouping.var = Species,
bar.fill = "orange",
nrow = 1,
messages = FALSE
)
# }
Run the code above in your browser using DataLab