histo_labeller

0th

Percentile

Custom function for adding labelled lines for x-axis variable.

Helper function for adding centrality parameter value and/or a test value for the continuous, numeric x-axis variable.

Keywords
internal
Usage
histo_labeller(plot, x, y.label.position, centrality.para = "mean",
  centrality.color = "blue", centrality.size = 1,
  centrality.linetype = "dashed", centrality.line.labeller = TRUE,
  centrality.k = 2, test.value = 0, test.value.line = FALSE,
  test.value.color = "black", test.value.size = 1,
  test.value.linetype = "dashed", test.line.labeller = TRUE,
  test.k = 0)
Arguments
plot

A ggplot object for which the labelled lines need to be added for a test value and/or a centrality parameter (mean/median) value.

x

A numeric variable.

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

centrality.line.labeller

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

centrality.k

Integer denoting the number of decimal places expected for centrality parameter label. (Default: 2).

test.value

A number specifying the value of the null hypothesis (Default: 0).

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

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

test.k

Integer denoting the number of decimal places expected for test.value label. (Default: 0 ).

Aliases
  • histo_labeller
Examples
# NOT RUN {
library(ggplot2)

# creating a ploton which lines and labels are to be superposed
p <- ggplot(mtcars, aes(wt, mpg)) + geom_point()

# computing `y`-axis positions for line labels
y_label_pos <- median(
  x = ggplot2::layer_scales(p)$y$range$range,
  na.rm = TRUE
)
# adding labels
ggstatsplot:::histo_labeller(
  plot = p,
  x = mtcars$wt,
  y.label.position = y_label_pos,
  test.value.line = TRUE
)
# }
# NOT RUN {
# }
Documentation reproduced from package ggstatsplot, version 0.0.10, License: GPL-3 | file LICENSE

Community examples

Looks like there are no examples yet.