stat_qq_band: Add confidence band for a QQ plot

In Katsevich-Lab/katlabutils: Utility functions broadly useful for Katsevich Lab research

Add confidence band for a QQ plot

Description

Add confidence band for a QQ plot

Usage

stat_qq_band(
  mapping = NULL,
  data = NULL,
  geom = "ribbon",
  position = "identity",
  show.legend = FALSE,
  inherit.aes = TRUE,
  distribution = "unif",
  max_pts_to_plot = 500,
  ci_level = 0.95,
  ...
)

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	The geometric object to use display the data
position	Position adjustment, either as a string, or the result of a call to a position adjustment function.
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().
distribution	The distribution with respect to which to make QQ plot (e.g. "unif", "norm", etc.); default "unif"
max_pts_to_plot	Points are downsampled for plotting purposes, so that the maximum number of points actually plotted is max_pts_to_plot.
ci_level	The pointwise confidence level for the QQ plot; default 0.95
...	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.

Katsevich-Lab/katlabutils documentation built on Aug. 7, 2024, 4:55 p.m.