# gghistostats

##### Histogram for distribution of a numeric variable

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

##### Arguments

- data
Dataframe from which variables specified are preferentially to be taken.

- x
A numeric variable.

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

- 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`

).

##### See Also

##### 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.adjust = TRUE,
binwidth = 0.10
)
# }
```

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