ploptions.list: The List of pl Options

In plgraphics: User Oriented Plotting Functions

The List of pl Options

Description

The user can set (and get) 'pl' options – mostly graphical "parameters" – which influence the behavior of plgraphics functions.

Usage

## not used, this gives the complete list of 'pl' options

Value

keeppar:

logical. If TRUE, the graphical parameter settings "mar", "oma", "cex", "mgp", and "mfg" will be maintained when leaving high level pl functions, otherwise, the old values will be restored (default).

colors:

The palette to be used by pl functions

pale:

default argument for colorpale

linewidth:

vector of lwd values to be used for the different line types (lty). The package sets lwd to a value ploptions("linewidth")[lty]*lwd intending to balance the visual impact of the different line types, e.g., to allow a dotted line to make a similar impression as a solid line.

csize:

General character size, relative to par("cex")

ticklength:

vector of 4 scalars: tickmark length, corresponding to par("tcl"). The first 2 elements define the length of the regular tickmarks, the other two, of the “small” tichmarks given by attr(ticksat, "small") (ticksat is a possible attribute of each variable). There are two elements each in order to define tickmarks that cross the axis.

tickintervals:

vector of length 2. The first element is the desired number of tick intervals for axes, to be used as argument n in pretty. The second determines how many tick labels are shown in the same way, and should therefore be smaller than (or equal to) the first.

pch:

plotting symbols or characters

csize.pch:

size of plotting symbols, relative to default. This may be a function with an argument that will be the number of observations at the time it is used.

csize.plab:

size of point labels, relative to csize.pch

psize.max:

maximum value of size of plotting symbols

lty, lwd, col, pcol, lcol:

line type, line width, color to be used

pcol, lcol:

color to be used for plotting symbols and labels, respectively

***

innerrange

innerrange

logical: should an innerrange be used in plots if needed?

innerrange.factor

factor needed to determined the inner range

innerrange.ext

extension of the inner range

innerrange.function

function used to calculate the inner range

plext

extension of the data range to the plotting range

markextremes

proportion of observations to be marked by their labels on the lower and upper extremes

variables.pch, variables.col, variables.lty, variables.lcol:

vectors of symbols, color, line type, line color to be used for showing different y variables

censored.pch, censored.size, censored.pale:

plotting symbol and size, and pale value to be applied to censored observations. Different symbols are used for distinguishing right and left censoring in vertical and horizontal direction and there combination.

group.pch, group.col, group.lty, group.lcol:

vector of symbols and colors used for observations and types and colors used for lines in the different groups

***

title parameters.

title.line

line in margin[3] on which the title appears

title.adj

adjustment of the title

title.csize

character size of the title, relative to ploptions("csize")*ploptions("margin.csize")[1]

title.csizemin

minimum csize

title.maxchars

maximum number of characters in title

sub

logical: should subtitle be shown?

xlab, ylab

labels of x and y axes

mframesmax

maximum number of panels to be shown on one page

panel

panel function to be used in high level pl functions

axes:

axes to be shown

***

margin parameters.

mar, oma

...

mar.default, oma.default

their default values

margin.csize

character size for variable labels and tick labels

margin.line

lines in margin where variable labels and tick labels are shown

margin.exp

expansion of margins beyond needed lines, for inner and outer margins

panelsep

space between panels

***

date parameters.

date.origin

The year which serves as origin of the internal (julian) date scale

date.format

format for showing dates

date.ticks

data.frame ruling how many small and large ticks and tick labels will be shown. The first column determines the row that will be used

gridlines:

can be
– a logical indicating if gridlines should be drawn. If TRUE, gridlines will be drawn at the values given in attr(.,"ticksat"); – a vector of values at which the gridlines should appear;
– a list of length 2 of such values;
– a named list. If a name equals the attribute varname of either the x or y variable, the respective component will be used.

zeroline:

logical: should zero (0) be shown be a special grid line? Can be numerical, then gives coordinates of such lines, generalizing the zero line.

zeroline.lty, zeroline.lwd, zeroline.col

line type, width and color of the zero line

refline

reference line, any line to be added to the current plot using the following properties. See plrefline for possible types of values

refline.lty, refline.lwd, refline.col

line type, width and color of the ref line

***

smooth.

smooth

logical: should a smoothing line be shown?

smooth.function:

function for calculating the smoother

smooth.par, smooth.iter

parameters for the function

smooth.minobs:

minimal number of observations needed for calculating a smooth.

smooth.band:

Indicator (logical) determining whether "low" and "high" smooth lines should be drawn. See above for their definition.

smooth.lty, smooth.col:

line type and color. Note that if there is a smooth.group factor, group.lty and group.col are used.

smooth.lwd:

line width. If of length 2 (or more), the second element is the factor by which the line width is reduced for simulated smooths (that is, for the second to the last column of smoothline$y). It defaults to 0.7.

smooth.pale

paling factor to be applied for secondary smooth lines

smooth.xtrim:

proportion of fitted values to be trimmed off on both sides when drawing a smooth line, either a number or a function that takes the number of points as its argument. The default is the simple function 2^log10(n)/n. The smoothing function may produce an attribute xtrim that is used as an additional factor to smooth.xtrim. This is applied, e.g., to suppress trimming if a straight line is fitted instead of a smooth by requiring smoothLm as the smoothing function.

bar.midpointwidth

width of the line shown at the central point of a bar

bar.lty, bar.lwd, bar.col

line type, width (for bar and midpoint line), color of bars

***

factors, multibox plots:

factor.show:

how should factors be plotted. Options are "mbox", "jitter" or "asis"

mbox.minobs

minimal number of observations shown as a multibox plot

mbox.minheigth

see ?plmboxes

mbox.colors

colors to be used for multibox plots

jitter

amount of jitter, or logical: should jittering be applied?

jitter.minobs

minimal number of observations to which jittering should be applied

jitter.factor

what proportion of the gap between different values will be filled by the jittering?

***

condquant: Conditional quantiles for censored residuals.

condquant:

logical: should bars be drawn for censored residuals? If FALSE, censored observations will be set to the median of the conditional distribution and shown by a different plotting character, see argument censored of ploptions. If NULL, the standard plotting character will be used.

condquant.probrange:

range for probabilities. If the probability corresponding to the censored part of the distribution is outside the range, bars will not be drawn.

condquant.pale:

factor by which the pcol color will be paled to show the points (condquant.pale[1]) and the bars (...[2]).

***

plcond: features of plcond.

plcond/panel:

panel function to be used

plcond.nintervals:

number of intervals into which numerical variables will be cut

plcond.extend:

proportion of neighboring intervals for which points are shown. 0 means no overlap.

plcond.col:

4 colors to be used to mark the points of the neighboing intervals: The first and second ones color the points lower or higher than the interval of the horizontal conditioning variable, and the other two regulating the same features for the vertical variable. The points which are outside the intervals of both conditioning variables will get a mixed color.

plond.pale:

minimum and maximum paling, to be applied for distance 0 and maximal distance from the interval.

plcond.cex:

symbol size, relative to cex, used to show the points outside the interval

subset.rgratio

adjust plot range for a subset if the range is smaller than subset.rgratio times the plot range for the full data set

functionxvalues

if a function is to be shown, the number of argument values for which the function is evaluated

***

options for the function plregr

regr.plotselect

selection of diagnostic plots that are produced, see ...

regr.addcomp

should residuals be shown as they are or component effects added to them?

leveragelimit

...

cookdistancelines

values of Cook's distance for which contours will be shown on the leverage plot

stamp

logical: should stamps be shown in the bottom right concern documenting the date and any project and step titles?

doc

logical: should any documentations of the data set be shown as subtitles, i.e., at in the top margin of the plot?

printnotices:

logical: should notices produced by the functions be shown?

debug:

Some functions that produce nice-to-have features are prevented from aborting the process if they fail (by using the try function) and produce a warning instead – unless debug is TRUE

Author(s)

Werner A. Stahel

See Also

ploptions

Examples

names(default.ploptions)

plgraphics documentation built on Oct. 19, 2023, 3 p.m.