ggstatsplot (version 0.0.12)

mean_ggrepel: Adding labels for mean values.

Description

Adding labels for mean values.

Usage

mean_ggrepel(plot, mean.data, mean.size = 5, mean.color = "darkred",
  mean.label.size = 3, mean.label.fontface = "bold",
  mean.label.color = "black", inherit.aes = TRUE, ...)

Arguments

plot

A ggplot object for which means are to be displayed.

mean.data

A dataframe containing means for each level of the factor. The columns should be titled x, y, and label.

mean.size

Point size for the data point corresponding to mean (Default: 5).

mean.color

Color for the data point corresponding to mean (Default: "darkred").

mean.label.size

Aesthetics for the label displaying mean. Defaults: 3, "bold","black", respectively.

mean.label.fontface

Aesthetics for the label displaying mean. Defaults: 3, "bold","black", respectively.

mean.label.color

Aesthetics for the label displaying mean. Defaults: 3, "bold","black", respectively.

inherit.aes

If FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from the default plot specification, e.g. borders.

...

Additional arguments.

Examples

# NOT RUN {
# }
# NOT RUN {
# this internal function may not have much utility outside of the package
set.seed(123)
library(ggplot2)

# make a plot
p <- ggplot(data = iris, aes(x = Species, y = Sepal.Length)) +
  geom_boxplot()

# get a dataframe with means
mean_dat <- ggstatsplot:::mean_labeller(
  data = iris,
  x = Species,
  y = Sepal.Length,
  mean.ci = TRUE,
  k = 3
) %>%
  dplyr::rename(.data = ., x = Species, y = Sepal.Length)

# add means
ggstatsplot:::mean_ggrepel(
  plot = p,
  mean.data = mean_dat,
  mean.color = "darkgreen"
)
# }