binmeans {micsr}

Compute the mean of a variable for bins of another variable

Description

Plot average values of the outcome for bins of the forcing variable, a common plot in regression discontinuity analysis

Usage

binmeans(x, y, width = NULL, center = NULL, g = NULL, ...)

## Default S3 method:
binmeans(x, y, width = NULL, center = NULL, g = NULL, ..., name_g = "colour")

## S3 method for class 'formula'
binmeans(x, y, width = NULL, center = NULL, ...)

StatBinmeans

geom_binmeans(
  mapping = NULL,
  data = NULL,
  stat = "binmeans",
  position = "identity",
  ...,
  center = NULL,
  width = NULL,
  na.rm = FALSE,
  show.legend = NA,
  inherit.aes = TRUE
)

Arguments

x, y

either two numeric vector for the default method, or a formula and a data frame for the formula method

width

the width of the bins

center

the cuting value of the forcing variable

g

a grouping variable

...

further arguments

name_g

internally used by the geom

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

Format

An object of class StatBinmeans (inherits from Stat, ggproto, gg) of length 4.