ps.options             package:grDevices             R Documentation

Auxiliary Function to Set/View Argument of postscript

Description:

     The auxiliary function 'ps.options' can be used to set and view
     (if called without arguments) default values for the arguments to
     'postscript'.

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

Usage:

     ps.options(..., reset = FALSE, override.check = FALSE)

Arguments:

     ...: arguments 'paper', 'horizontal', 'width', 'height', 'family',
          'encoding', 'pointsize', 'bg', 'fg', 'onefile' (unused),
          'print.it', 'append' (unused), 'pagecentre', 'command' and
          'colormodel' can be supplied.

reset, override.check: logical arguments passed to 'check.options'. 
          See the Examples.

Details:

     Note that despite the name, these settings also provide the
     defaults for some of the arguments for 'pdf' and 'xfig', although
     not in all cases even when they have arguments of the same name.

     Arguments 'onefile' and 'append' are accepted but are unused in
     any of the graphics devices making use of this function.

     For 'pdf', arguments 'family', 'encoding' 'pointsize', 'bg', 'fg'
     and 'pagecentre' are used.

     For 'xfig', arguments 'paper', 'horizontal', 'width', 'height',
     'family', 'pointsize', 'bg', 'fg' and 'pagecentre' are used.

Value:

     A named list of default values for arguments.

See Also:

     'postscript'

Examples:

     ps.options(bg = "pink")
     utils::str(ps.options(reset = TRUE))

     ### ---- error checking of arguments: ----
     ps.options(width=0:12, onefile=0, bg=pi)
     # override the check for 'onefile', but not the others:
     utils::str(ps.options(width=0:12, onefile=1, bg=pi,
                           override.check = c(FALSE,TRUE,FALSE)))

