- 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
statistic to use to calculate confidence bands. Should be
`qq_band`.
- 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().
- distribution
Character. Theoretical probability distribution function
to use. Do not provide the full distribution function name (e.g.,
"dnorm"). Instead, just provide its shortened name (e.g.,
"norm"). If you wish to provide a custom distribution, you may do so
by first creating the density, quantile, and random functions following the
standard nomenclature from the stats package (i.e., for
"custom", create the dcustom, pcustom,
qcustom, and rcustom functions).
- dparams
List of additional parameters passed on to the previously
chosen distribution function. If an empty list is provided (default)
then the distributional parameters are estimated via MLE. MLE for custom
distributions is currently not supported, so you must provide the
appropriate dparams in that case.
- detrend
Logical. Should the plot objects be detrended? If TRUE,
the objects will be detrended according to the reference Q-Q line. This
procedure was described by Thode (2002), and may help reducing visual bias
caused by the orthogonal distances from Q-Q points to the reference line.
- identity
Logical. Should an identity line be used as the reference
line used to construct the confidence bands? If TRUE, the identity
line is used. If FALSE (default), the commonly-used Q-Q line that
intercepts two data quantiles specified in qprobs is used. Please
notice that the chosen reference line will also be used for the detrending
procedure, if detrend = TRUE.
- qtype
Integer between 1 and 9. Type of the quantile algorithm to be
used by the quantile function to construct the Q-Q
line.
- qprobs
Numeric vector of length two. Represents the quantiles used by
the quantile function to construct the Q-Q line.
- bandType
Character. Either "pointwise", "boot", "ks" or
"ts", or "ell". "pointwise" constructs pointwise confidence bands based
on Normal confidence intervals. "boot" creates pointwise confidence
bands based on a parametric bootstrap; parameters are estimated with MLEs.
"ks" constructs simultaneous confidence bands based on the Kolmogorov-Smirnov
test. "ts" constructs tail-sensitive confidence bands, as
described by Aldor-Noiman et al. (2013) (also, see 'Note' for
limitations). Finally, "ell" constructs simultaenous bands using the
equal local levels test describe by Weine et al. (2021).
- B
Integer. If bandType = "boot", then B is the number of
bootstrap replicates. If bandType = "ts", then B is the
number of simulated samples.
- conf
Numerical. Confidence level of the bands.
- mu
Numerical. Only used if bandType = "ts". Center
distributional parameter used to construct the simulated tail-sensitive
confidence bands. If either mu or sigma are NULL, then
those parameters are estimated using Qn and
s_Qn, respectively.
- sigma
Numerical. Only used if bandType = "ts". Scale
distributional parameter used to construct the simulated tail-sensitive
confidence bands. If either mu or sigma are NULL, then
those parameters are estimated using robust estimates from the stats
package.
- ...
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.
- geom
The geometric object to use to display the data, either as a
ggproto Geom subclass or as a string naming the geom stripped of the
geom_ prefix (e.g. "point" rather than "geom_point")