plot_describe: Plot a histogram or dotplot of an estimated magnitude with...
In rcalinjageman/esci4: Effect Sizes and Confidence Intervals

plot_describe

R Documentation

Plot a histogram or dotplot of an estimated magnitude with raw data

Description

esci_plot_describe returns a ggplot2 object

Usage

plot_describe(
  estimate,
  type = c("histogram", "dotplot"),
  mark_mean = FALSE,
  mark_median = FALSE,
  mark_sd = FALSE,
  mark_quartiles = FALSE,
  mark_z_lines = FALSE,
  mark_percentile = NULL,
  histogram_bins = 12,
  ylim = c(0, NA),
  ybreaks = NULL,
  xlim = c(NA, NA),
  xbreaks = NULL,
  fill_regular = "#008DF9",
  fill_highlighted = "#E20134",
  color = "black",
  marker_size = 5,
  ggtheme = NULL
)

Arguments

`estimate`	A esci_estimate object with raw data an es_mean
`type`	histogram or dotplot
`mark_mean`	should mean be marked?
`mark_median`	should median be marked?
`mark_sd`	should mean be marked?
`mark_quartiles`	should mean be marked?
`mark_z_lines`	should z lines be marked?
`mark_percentile`	a percentile (0 to 1) to be marked
`histogram_bins`	number of bins if a histogram
`ylim`	2-length numeric vector
`ybreaks`	numeric >= 1
`xlim`	2-length numeric vector
`xbreaks`	numeric >= 1
`fill_regular`	color for
`fill_highlighted`	color for
`color`	outline color
`marker_size`	Size of markers
`ggtheme`	theme to apply, if any