ggstatsplot (version 0.0.3)

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 = TRUE, k = 3, low.color = "#0072B2",
  high.color = "#D55E00", results.subtitle = TRUE,
  legend.title.margin = TRUE, 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, messages = TRUE)

Arguments

data

Dataframe from which variables specified are preferentially to be taken.

x

A numeric variable.

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.

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.

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.

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.

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

t.margin, 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).

messages

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

See Also

grouped_gghistostats

Examples

# NOT RUN {
# most basic function call with the defaults
ggstatsplot::gghistostats(
data = datasets::ToothGrowth,
x = len,
xlab = "Tooth length")

# another example
ggstatsplot::gghistostats(
data = NULL,
x = stats::rnorm(n = 1000, mean = 0, sd = 1),
centrality.para = "mean",
type = "np"
)

# more detailed function call
ggstatsplot::gghistostats(
data = datasets::iris,
x = Sepal.Length,
type = "bf",
bf.prior = 0.8,
test.value = 3,
centrality.para = "mean",
test.value.line = TRUE,
binwidth = 0.10
)

# }