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
.
Grouping variable.
Dataframe from which variables specified are preferentially to be taken.
A numeric variable.
Label for x
axis variable.
The text for the plot subtitle if you don't want results from one sample test to be displayed.
The text for the plot caption.
Type of statistic expected ("parametric"
or "nonparametric"
or
"bayes"
). Abbreviations accepted are "p"
or "np"
or "bf"
, respectively.
A number specifying the value of the null hypothesis.
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 if the null hypothesis can't be
rejected (Default: bf.message = TRUE
).
Number of decimal places expected for results.
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 colour for the vertical line for centrality
parameter (Default: "blue"
).
Decides whether test value is to be displayed as a
vertical line (Default: FALSE
).
Decides colour for the vertical line denoting test
value (Default: "black"
).
If set to TRUE
, you can use it to pick better value
with the binwidth
argument to stat_bin()
.
The width of the bins. Can be specified as a numeric value,
or a function that calculates width from x
. The default is to use bins
bins that cover the range of the data. You should always override this
value, exploring multiple widths to find the best to illustrate the stories
in your data.
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", etc.) 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"
, "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.
Point size of annotation text.
The x position of annotation label.
The y position of annotation label.
Horizontal justification for annotation label.
Vertical justification for annotation label.
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.
The font face ("plain"
, "bold"
, "italic"
,
"bold.italic"
) for the annotation label.
Angle at which annotation label is to be drawn.
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).
# NOT RUN {
library(gapminder)
ggstatsplot::grouped_gghistostats(
data = gapminder::gapminder,
x = lifeExp,
xlab = "Life expectancy",
test.value = 50,
grouping.var = continent,
nrow = 3,
messages = FALSE
)
# }
Run the code above in your browser using DataCamp Workspace