distrEllipseoptions {distrEllipse}

functions to change the global variables of the package ‘distrEllipse’

Description

With distrEllipseoptions and getdistrEllipseOption you may inspect and change the global variables used by package distrEllipse.

Usage

distrEllipseoptions(...)
getdistrEllipseOption(x)

Arguments

...

any options can be defined, using name = value or by passing a list of such tagged values.

x

a character string holding an option name.

Details

Invoking distrEllipseoptions() with no arguments returns a list with the current values of the options. To access the value of a single option, one should use getdistrEllipseOption("WarningSim"), e.g., rather than distrEllipseoptions("WarningSim") which is a list of length one.

Value

distrEllipseoptions() returns a list of the global options of distrEllipse.
distrEllipseoptions("Nsim") returns the global option Nsim as a list of length 1.
distrEllipseoptions("Nsim" = 3000) sets the value of the global option Nsim to 3000. getdistrEllipseOption("Nsim") the current value set for option Nsim.

Currently available options

Nsim

for plotting: number of (simulated) points to be plotted.

withED

for plotting: logical; shall principal axes of the contour ellipsoid be plot in (for each panel)?

lwd.Ed

for plotting: line width of principal axes (for each panel).

col.Ed

for plotting: color of principal axes (for each panel).

withMean

for plotting: logical; shall mean be plot in (for each panel)?

cex.mean

for plotting: size of the mean symbol (for each panel).

pch.mean

for plotting: mean symbol (for each panel).

col.mean

for plotting: color of the mean symbol (for each panel).

Author(s)

Peter Ruckdeschel [e-mail]

See Also

options, getOption

Examples

distrEllipseoptions("Nsim") # returns the value of Nsim, by default = 5
currentDistrOptions <- distrEllipseoptions()
distrEllipseoptions(Nsim = 6000)
distrEllipseoptions("Nsim")
getdistrEllipseOption("Nsim")
distrEllipseoptions(c("Nsim","withED"))