geom_describe {plutor}

Description values plot

Description

The describe geom is used to create description values plot, including center symbol and error symbol. The center symbol can be mean, median or other custom functions, the error symbol can be sd, quantile or other custom functions.

Usage

geom_describe(
  mapping = NULL,
  data = NULL,
  stat = "describe",
  position = "identity",
  na.rm = FALSE,
  show.legend = NA,
  inherit.aes = TRUE,
  lineend = "round",
  show_error = TRUE,
  center_symbol = "bar",
  center_width = 0.3,
  error_width = 0.2,
  center_func = mean,
  low_func = function(x, na.rm) {
     mean(x, na.rm = na.rm) - sd(x, na.rm = na.rm)
 },
  high_func = function(x, na.rm) {
     mean(x, na.rm = na.rm) + sd(x, na.rm = na.rm)
 },
  ...
)

Arguments

mapping

Set of aesthetic mappings created by aes(). If specified and inherit.aes = TRUE (the default), it is combined with the default mapping at the top level of the plot. You must supply mapping if there is no plot mapping.

data

The data to be displayed in this layer. There are three options:

If NULL, the default, the data is inherited from the plot data as specified in the call to ggplot().

A data.frame, or other object, will override the plot data. All objects will be fortified to produce a data frame. See fortify() for which variables will be created.

A function will be called with a single argument, the plot data. The return value must be a data.frame, and will be used as the layer data. A function can be created from a formula (e.g. ~ head(.x, 10)).

stat

The statistical transformation to use on the data for this layer, either as a ggproto Geom subclass or as a string naming the stat stripped of the stat_ prefix (e.g. "count" rather than "stat_count")

position

Position adjustment, either as a string naming the adjustment (e.g. "jitter" to use position_jitter), or the result of a call to a position adjustment function. Use the latter if you need to change the settings of the adjustment.

na.rm

If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.

show.legend

logical. Should this layer be included in the legends? NA, the default, includes if any aesthetics are mapped. FALSE never includes, and TRUE always includes. It can also be a named logical vector to finely select the aesthetics to display.

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

lineend

Line end style (round, butt, square).

show_error

show error symbol

center_symbol

one of ⁠point, bar⁠

center_width

if center_symbol='bar', the width of the bar

error_width

the width of the error bar

center_func

the center function, mean as default

low_func

the low error function, mean minus sd as default

high_func

the high error function, mean plus sd as default

...

Other arguments passed on to ggplot2::point() or ggplot2::geom_segment.

Value

ggplot object