get_set_qqplot_param: Plotting parameters for QQ Plots

View source: R/auxiliaries.R

get_set_qqplot_paramR Documentation

Plotting parameters for QQ Plots

Description

Plotting parameters for the method plot() of the class qqplot_maha.

Usage

get_set_qqplot_param(plot.pars = list(log = ""))

Arguments

plot.pars

list specifying plotting parameters to be set; see below under details.

Details

This function provides a convenient way to set plotting parameters in the argument plot.pars of the function qqplot_maha() (more precisely, the underlying plot() method), such as logarithmic plotting, colors, linetypes and more.

The input list plot.pars can contain any of the following:

log

character specifying the logarithmic axes. Just like for the generic plot, must be one of "", "x", "y" or "xy".

xlim, ylim

The x- and y-limits for plotting.

xlab, ylab

character specifying the x- and y-axis labels. Default to "Theoretical quantiles" and "Sample quantiles", respectively.

sub, main

character specifying title and subtitle of the plot; default to "", so no titles.

plot_legend, plot_test, plot_line

logical specifying if a legend should be plotted; if the test result of the GoF test should be displayed on the 3rd axis and if the plot should contain a fitted line. All default to TRUE.

pch

specification of the plotting symbol; see ?points(). Defaults to 1.

lty

3-vector containing the specification of the linetypes for i) the diagonal, ii) the asymptotic CI and iii) the bootstrap CI; see also ?par(). Defaults to 1:3.

col

4-vector specifying the colors to be used for i) the points in the QQ plot; ii) the diagonal; iii) the asymptotic CI and iv) the bootstrap CI. Defaults to c("black", "red", "azure4", "chocolate4").

Value

get_set_qqplot_param() returns a list with 13 elements that is passed to qqplot_maha(), more specifically, to the underlying plot() method. Parameter values passed to get_set_qqplot_param() via the plot.pars argument overwrite the defaults; for parameters not specified in the plot.pars argument, the default values are being returned.

Author(s)

Erik Hintz, Marius Hofert and Christiane Lemieux

See Also

qqplot_maha()

Examples

get_set_qqplot_param(plot.pars = list()) # obtain defaults

## See ?qqplot_maha() for more examples.

nvmix documentation built on March 19, 2024, 3:07 a.m.