line_labeller

0th

Percentile

Adds a label to the horizontal or vertical line.

Adds a label to the horizontal or vertical line.

Keywords
internal
Usage
line_labeller(plot, x, y, k = 2, color, label.text,
  line.direction = "vline", jitter = 0.25)
Arguments
plot

A ggplot object in which the label needs to be displayed.

x, y

The x- and y-axes coordinates for the label.

k

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

color

Color of the label.

label.text

The text to include in the label (e.g., "mean").

line.direction

Character that specifies whether the line on which label is to be attached is vertical ("vline", default) or horizontal ("hline") line.

jitter

Numeric that specifies how much the label should be jittered in the vertical direction (default: 0.25). The sign will determine the direction (upwards or downwards).

Aliases
  • line_labeller
Examples
# NOT RUN {
# creating a basic plot
set.seed(123)
library(ggplot2)
p <- ggplot(mtcars, aes(wt, mpg)) + geom_point()

# adding a label
ggstatsplot:::line_labeller(
  plot = p,
  x = median(mtcars$wt),
  y = mean(mtcars$mpg),
  k = 2,
  color = "red",
  label.text = "median"
)
# }
Documentation reproduced from package ggstatsplot, version 0.0.11, License: GPL-3 | file LICENSE

Community examples

Looks like there are no examples yet.