R: Auxiliary Function to Set/View Defaults for Arguments of...

pdf.options {grDevices}

R Documentation

Auxiliary Function to Set/View Defaults for Arguments of `pdf`

Description

The auxiliary function pdf.options can be used to set or view (if called without arguments) the default values for most of the arguments to pdf.

pdf.options needs to be called before calling pdf, and the default values it sets can be overridden by supplying arguments to pdf.

Usage

pdf.options(..., reset = FALSE)

Arguments

`...`	arguments `width`, `height`, `onefile`, `family`, `title`, `fonts`, `version`, `paper`, `encoding`, `bg`, `fg`, `pointsize`, `pagecentre`, `colormodel`, `useDingbats`, `useKerning`, `fillOddEven`, `compress`, `timestamp`, `producer` and `author` can be supplied.
`reset`	logical: should the defaults be reset to their ‘factory-fresh’ values?

Details

If both reset = TRUE and ... are supplied the defaults are first reset to the ‘factory-fresh’ values and then the new values are applied.

Value

A named list of all the defaults. If any arguments are supplied the return values are the old values and the result has the visibility flag turned off.

Examples

pdf.options(bg = "pink")
utils::str(pdf.options())
pdf.options(reset = TRUE) # back to factory-fresh

[Package grDevices version 4.5.0 Index]

Auxiliary Function to Set/View Defaults for Arguments of pdf