grouped_gghistostats

0th

Percentile

Grouped histograms for distribution of a numeric variable

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.

Arguments
grouping.var

Grouping variable.

data

Dataframe from which variables specified are preferentially to be taken.

x

A numeric variable.

xlab

Label for x axis variable.

subtitle

The text for the plot subtitle if you don't want results from one sample test to be displayed.

caption

The text for the plot caption.

type

Type of statistic expected ("parametric" or "nonparametric" or "bayes"). Abbreviations accepted are "p" or "np" or "bf", respectively.

test.value

A number specifying the value of the null hypothesis.

bf.prior

A number between 0.5 and 2 (default 0.707), the prior width to use in calculating Bayes factors.

bf.message

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).

k

Number of decimal places expected for results.

results.subtitle

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.

centrality.para

Decides which measure of central tendency ("mean" or "median") is to be displayed as a vertical line.

centrality.colour

Decides colour for the vertical line for centrality parameter (Default: "blue").

test.value.line

Decides whether test value is to be displayed as a vertical line (Default: FALSE).

test.value.colour

Decides colour for the vertical line denoting test value (Default: "black").

binwidth.adjust

If set to TRUE, you can use it to pick better value with the binwidth argument to stat_bin().

binwidth

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.

messages

Decides whether messages references, notes, and warnings are to be displayed (Default: TRUE).

...

Arguments passed on to combine_plots

title.text

String or plotmath expression to be drawn as title for the combined plot.

title.colour

Text color for title.

title.size

Point size of title text.

title.vjust

Vertical justification for title. Default = 0.5 (centered on y). 0 = baseline at y, 1 = ascender at y.

title.hjust

Horizontal justification for title. Default = 0.5 (centered on x). 0 = flush-left at x, 1 = flush-right.

title.fontface

The font face ("plain", "bold", etc.) for title.

caption.text

String or plotmath expression to be drawn as the caption for the combined plot.

caption.colour

Text color for caption.

caption.size

Point size of title text.

caption.vjust

Vertical justification for caption. Default = 0.5 (centered on y). 0 = baseline at y, 1 = ascender at y.

caption.hjust

Horizontal justification for caption. Default = 0.5 (centered on x). 0 = flush-left at x, 1 = flush-right.

caption.fontface

The font face ("plain", "bold", "italic", "bold.italic") for caption.

sub.text

The label with which the combined plot should be annotated. Can be a plotmath expression.

sub.colour

Text color for annotation label.

sub.size

Point size of annotation text.

sub.x

The x position of annotation label.

sub.y

The y position of annotation label.

sub.hjust

Horizontal justification for annotation label.

sub.vjust

Vertical justification for annotation label.

sub.vpadding

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.

sub.fontface

The font face ("plain", "bold", "italic", "bold.italic") for the annotation label.

sub.angle

Angle at which annotation label is to be drawn.

sub.lineheight

Line height of annotation label.

title.caption.rel.heights

Numerical vector of relative columns heights while combining (title, plot, caption).

title.rel.heights

Numerical vector of relative columns heights while combining (title, plot).

caption.rel.heights

Numerical vector of relative columns heights while combining (plot, caption).

See Also

gghistostats

Aliases
  • grouped_gghistostats
Examples
# 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
)

# }
Documentation reproduced from package ggstatsplot, version 0.0.2, License: GPL-3 | file LICENSE

Community examples

Looks like there are no examples yet.