ggstatsplot (version 0.0.6)

gghistostats: Histogram for distribution of a numeric variable

Description

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

Usage

gghistostats(data = NULL, x, 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 = 100,
  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)

Arguments

data

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

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 (only available from ggplot2 3.0.1 onward).

xlab

Label for x axis variable.

title

The text for the plot title.

subtitle

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

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 (Default: 0).

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 (Default: bf.message = FALSE). This will work only if results.subtitle = 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 (Default: 100).

k

Number of digits after decimal point (should be an integer) (Default: k = 3).

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_economist(), hrbrthemes::theme_ipsum_ps(), ggthemes::theme_fivethirtyeight(), etc.).

ggstatsplot.layer

Logical that decides whether theme_ggstatsplot theme elements are to be displayed along with the selected ggtheme (Default: TRUE).

fill.gradient

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.

low.color, high.color

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

bar.fill

If fill.gradient = FALSE, then bar.fill 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 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.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").

test.line.labeller, centrality.line.labeller

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

test.k, centrality.k

Integer denoting the number of decimal places expected for test and centrality parameters. (Default: 0 and 2, respectively).

messages

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

References

https://cran.r-project.org/package=ggstatsplot/vignettes/gghistostats.html

See Also

grouped_gghistostats

Examples

# NOT RUN {
# most basic function call with the defaults
# this is the only function where data argument can be `NULL`.
ggstatsplot::gghistostats(
  x = ToothGrowth$len,
  xlab = "Tooth length",
  centrality.para = "median"
)

# a detailed function call
ggstatsplot::gghistostats(
  data = datasets::iris,
  x = Sepal.Length,
  bar.measure = "count",
  type = "p",
  bf.message = TRUE,
  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"
)
# }