R.devices (version 2.17.0)

devOptions: Gets the default device options

Description

Gets the default device options as given by predefined devices options adjusted for the default arguments of the device function.

Usage

devOptions(type=NULL, custom=TRUE, special=TRUE, inherits=FALSE, drop=TRUE,
  options=list(), ..., reset=FALSE)

Arguments

type

A character string or a device function specifying the device to be queried. May also be a vector, for querying device options for multiple devices.

custom

If TRUE, also the default settings specific to this function is returned. For more details, see below.

special

A logical. For more details, see below.

inherits

If TRUE, the global option is used if the type-specific is not set (or NULL).

drop

If TRUE and only one device type is queried, then a list is returned, otherwise a matrix.

options

Optional named list of settings.

...

Optional named arguments for setting new defaults. For more details, see below.

reset

If TRUE, the device options are reset to R defaults.

Value

If drop=TRUE and a single device is queries, a named list is returned, otherwise a matrix is returned. If a requested device is not implemented/supported on the current system, then "empty" results are returned. If options were set, that is, if named options were specified via ..., then the list is returned invisibly, otherwise not.

Setting new defaults

When setting device options, the getOption("devOptions")[[type]] option is modified. This means that for such options to be effective, any device function needs to query also such options, which for instance is done by devNew().

Also, for certain devices (eps, pdf, postscript, quartz, windows and x11), builtin R device options are set.

Details

If argument special is TRUE, then the 'width' and 'height' options are adjusted according to the rules explained for argument 'paper' in pdf, postscript, and xfig.

Examples

# NOT RUN {
# Tabulate some of the default settings for known devices
print(devOptions()[,c("width", "height", "bg", "fg", "pointsize")])
# }