Histogram for distribution of a numeric variable

Histogram with statistical details from one-sample test included in the plot as a subtitle.

gghistostats(
  data,
  x,
  binwidth = NULL,
  bar.measure = "count",
  xlab = NULL,
  stat.title = NULL,
  title = NULL,
  subtitle = NULL,
  caption = NULL,
  type = "parametric",
  test.value = 0,
  bf.prior = 0.707,
  bf.message = TRUE,
  effsize.type = "g",
  effsize.noncentral = TRUE,
  conf.level = 0.95,
  nboot = 100,
  k = 2,
  ggtheme = ggplot2::theme_bw(),
  ggstatsplot.layer = TRUE,
  bar.fill = "grey50",
  results.subtitle = TRUE,
  test.k = 0,
  test.value.line = FALSE,
  test.value.line.args = list(size = 1),
  test.value.label.args = list(size = 3),
  centrality.parameter = "mean",
  centrality.k = 2,
  centrality.line.args = list(size = 1, color = "blue"),
  centrality.label.args = list(color = "blue", size = 3),
  normal.curve = FALSE,
  normal.curve.args = list(size = 3),
  ggplot.component = NULL,
  output = "plot",
  messages = TRUE,
  ...
)

Arguments

data	A dataframe (or a tibble) from which variables specified are to be taken. A matrix or tables will not be accepted.
x	A numeric variable.
binwidth	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.
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, or "mix", which shows both count and proportion in the same plot.
xlab	Labels for x and y axis variables. If NULL (default), variable names for x and y will be used.
stat.title	A character describing the test being run, which will be added as a prefix in the subtitle. The default is NULL. An example of a stat.title argument will be something like "Student's t-test: ".
title	The text for the plot title.
subtitle	The text for the plot subtitle. Will work only if results.subtitle = FALSE.
caption	The text for the plot caption.
type	Type 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.value	A number specifying the value of the null hypothesis (Default: 0).
bf.prior	A numeric value between 0.5 and 2 (default 0.707), the prior width to use in calculating Bayes Factors.
bf.message	Logical that decides whether to display Bayes Factor in favor of the null hypothesis. This argument is relevant only for parametric test (Default: TRUE).
effsize.type	Type of effect size needed for parametric tests. The argument can be "biased" ("d" for Cohen's d) or "unbiased" ("g" Hedge's g for t-test). The default is "g".
effsize.noncentral	Logical indicating whether to use non-central t-distributions for computing the confidence interval for Cohen's d or Hedge's g (Default: TRUE).
conf.level	Scalar between 0 and 1. If unspecified, the defaults return 95% lower and upper confidence intervals (0.95).
nboot	Number of bootstrap samples for computing confidence interval for the effect size (Default: 100).
k	Number of digits after decimal point (should be an integer) (Default: k = 2).
ggtheme	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_fivethirtyeight(), hrbrthemes::theme_ipsum_ps(), etc.).
ggstatsplot.layer	Logical 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.
bar.fill	Character input that decides which color will uniformly fill all the bars in the histogram (Default: "grey50").
results.subtitle	Decides 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.
test.k	Integer denoting the number of decimal places expected for test.value label. (Default: 0 ).
test.value.line	Logical that decides whether a line corresponding to the test.value should be superimposed on the plot.
test.value.line.args	A 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.args	A 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.parameter	Decides 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.k	Integer denoting the number of decimal places expected for centrality parameter label. (Default: 2).
centrality.line.args	A 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.args	A 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.
normal.curve	A logical value that decides whether to super-impose a normal curve using stats::dnorm(mean(x), sd(x)). Default is FALSE.
normal.curve.args	A list of additional aesthetic arguments to be passed to the normal curve.
ggplot.component	A 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.
output	Character that describes what is to be returned: can be "plot" (default) or "subtitle" or "caption". Setting this to "subtitle" will return the expression containing statistical results. If you have set results.subtitle = FALSE, then this will return a NULL. Setting this to "caption" will return the expression containing details about Bayes Factor analysis, but valid only when type = "parametric" and bf.message = TRUE, otherwise this will return a NULL.
messages	Decides whether messages references, notes, and warnings are to be displayed (Default: TRUE).
...	Currently ignored.

References

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

See also

grouped_gghistostats, ggdotplotstats, grouped_ggdotplotstats

Examples

# \donttest{
# most basic function call with the defaults
# this is the **only** function where data argument can be `NULL`
ggstatsplot::gghistostats(
  data = ToothGrowth,
  x = len,
  xlab = "Tooth length",
  centrality.parameter = "median"
)
#> Warning: full precision may not have been achieved in 'pnt{final}'
#> Warning: full precision may not have been achieved in 'pnt{final}'
#> t is large; approximation invoked.
#> Note: Shapiro-Wilk Normality Test for Tooth length: p-value = 0.109
#> 

# a detailed function call
ggstatsplot::gghistostats(
  data = iris,
  x = Sepal.Length,
  bar.measure = "mix",
  type = "p",
  caption = substitute(paste(italic("Note"), ": Iris dataset by Fisher.")),
  bf.prior = 0.8,
  test.value = 3,
  test.value.line = TRUE,
  binwidth = 0.10,
  bar.fill = "grey50"
)
#> Warning: full precision may not have been achieved in 'pnt{final}'
#> Warning: full precision may not have been achieved in 'pnt{final}'
#> Warning: full precision may not have been achieved in 'pnt{final}'
#> t is large; approximation invoked.
#> Note: Shapiro-Wilk Normality Test for Sepal.Length: p-value = 0.010
#> 
# }