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.

Usage
grouped_gghistostats(data, x, grouping.var, title.prefix = "Group",
  bar.measure = "count", xlab = NULL, subtitle = NULL,
  caption = NULL, type = "parametric", test.value = 0,
  bf.prior = 0.707, bf.message = TRUE, robust.estimator = "onestep",
  nboot = 500, k = 3, low.color = "#0072B2",
  high.color = "#D55E00", results.subtitle = TRUE,
  legend.title.margin = FALSE, t.margin = unit(0, "mm"),
  b.margin = unit(3, "mm"), centrality.para = NULL,
  centrality.color = "blue", centrality.size = 1.2,
  centrality.linetype = "dashed", test.value.line = FALSE,
  test.value.color = "black", test.value.size = 1.2,
  test.value.linetype = "dashed", line.labeller = FALSE,
  line.labeller.y = -2, binwidth = NULL,
  ggtheme = ggplot2::theme_bw(), fill.gradient = TRUE,
  messages = TRUE, ...)
Arguments
data

Dataframe from which variables specified are preferentially to be taken. This argument is optional.

x

A numeric variable.

grouping.var

Grouping variable.

title.prefix

Character specifying the prefix text for the fixed plot title (name of each factor level) (Default: "Group").

bar.measure

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.

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 "robust" or "bayes"). Abbreviations accepted are "p" or "np" or "r" 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).

robust.estimator

If test = "robust" robust estimator to be used ("onestep" (Default), "mom", or "median"). For more, see ?WRS2::onesampb.

nboot

Number of bootstrap samples for robust one-sample location test.

k

Number of decimal places expected for results.

low.color

Colors for low and high ends of the gradient. Defaults are colorblind-friendly.

high.color

Colors for low and high ends of the gradient. Defaults are colorblind-friendly.

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.

legend.title.margin

Adjusting the margin between legend title and the colorbar (Default: FALSE).

t.margin

Margins in grid units. For more details, see ?grid::unit().

b.margin

Margins in grid units. For more details, see ?grid::unit().

centrality.para

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

centrality.color

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

centrality.size

Decides size for the vertical line for centrality parameter (Default: 1.2).

centrality.linetype

Decides linetype for the vertical line for centrality parameter (Default: "dashed").

test.value.line

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

test.value.color

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

test.value.size

Decides size for the vertical line for test value (Default: 1.2).

test.value.linetype

Decides linetype for the vertical line for test value (Default: "dashed").

line.labeller

A logical that decides whether line labels should be displayed (Default: FALSE).

line.labeller.y

A numeric denoting the y-coordinate for displaying line labels (Default: -2).

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.

ggtheme

A function, ggplot2 theme name. Default value is ggplot2::theme_bw(). Allowed values are the official ggplot2 themes, including theme_grey(), theme_minimal(), theme_classic(), theme_void(), etc.

fill.gradient

Logical decides whether color fill gradient is to be displayed (Default: TRUE). If FALSE, the legend will also be removed.

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

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" (default), "italic", "bold.italic") for title.

caption.text

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

caption.color

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" (default), "bold", "italic", "bold.italic") for caption.

sub.text

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

sub.color

Text color for annotation label (Default: "black").

sub.size

Point size of annotation text (Default: 12).

sub.x

The x position of annotation label (Default: 0.5).

sub.y

The y position of annotation label (Default: 0.5).

sub.hjust

Horizontal justification for annotation label (Default: 0.5).

sub.vjust

Vertical justification for annotation label (Default: 0.5).

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 (Default: grid::unit(1, "lines")).

sub.fontface

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

sub.angle

Angle at which annotation label is to be drawn (Default: 0).

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

References

https://indrajeetpatil.github.io/ggstatsplot/articles/gghistostats.html

See Also

gghistostats

Aliases
  • grouped_gghistostats
Examples
# NOT RUN {
ggstatsplot::grouped_gghistostats(
  data = iris,
  x = Sepal.Length,
  test.value = 5,
  grouping.var = Species,
  nrow = 1,
  messages = FALSE
)
# }
Documentation reproduced from package ggstatsplot, version 0.0.5, License: GPL-3 | file LICENSE

Community examples

Looks like there are no examples yet.