stat_propzero: Summarise proportion of zeros in 'y' at each 'x'

In milanmlft/MMmotley: A motley collection of R functions for data analysis

Description

stat_propzero() calculates the proportion of zeros in y for each unique x and uses geom_text() by default to add annotations to the plot.

Usage

stat_propzero(
  mapping = NULL,
  data = NULL,
  geom = "text",
  position = "identity",
  na.rm = FALSE,
  show.legend = NA,
  inherit.aes = TRUE,
  ...,
  format.fun = scales::label_percent()
)

Arguments

mapping	Set of aesthetic mappings created by aes() or 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)).
geom	Override the default connection between geom_bar() and stat_count().
position	Position adjustment, either as a string, or the result of a call to a position adjustment function.
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().
...	Other arguments passed on to layer(). These are often aesthetics, used to set an aesthetic to a fixed value, like colour = "red" or size = 3. They may also be parameters to the paired geom/stat.
format.fun	Function to format labels when using geom = "text" (the default) to depict the proportion of zeros. By default, uses scales::label_percent().

Computed variables

stat_propzero() provides the following variables:

propzero

proportion of zeros

Examples

library(ggplot2)
## Generate some random zero-inflated data
n <- 100
p <- 0.123
y <- ifelse(rbinom(n, size = 1, prob = p) > 0, 0, rpois(n, lambda = 2))
df <- data.frame(x = rep(c("A", "B"), each = n / 2), y = y)

## Make plot
p <- ggplot(df, aes(x, y)) + geom_jitter(alpha = 0.2, width = 0.1)
p + stat_propzero()

## Use a different formatting function
p + stat_propzero(format.fun = scales::label_scientific())
p + stat_propzero(format.fun = function(x) format(x, digits = 1))
p + stat_propzero(format.fun = scales::label_percent(accuracy = 0.01))

## Adjust label position with `hjust` and `vjust`
p + stat_propzero(vjust = 3)
p + stat_propzero(hjust = 3)
p + stat_propzero(hjust = 3, vjust = 3)

## Using a different `geom` than text
## This will require mapping of the `propzero` stat to another aesthetic
## with `after_stat`.
p + stat_propzero(aes(col = after_stat(propzero)), geom = "point", size = 5)
p + stat_propzero(aes(size = after_stat(propzero)), geom = "point")

milanmlft/MMmotley documentation built on Feb. 4, 2022, 7:42 a.m.