spatstat (version 1.48-0)

spatstat.options: Internal Options in Spatstat Package

Description

Allows the user to examine and reset the values of global parameters which control actions in the spatstat package.

Usage

spatstat.options(...) reset.spatstat.options()

Arguments

...

Either empty, or a succession of parameter names in quotes, or a succession of name=value pairs. See below for the parameter names.

Value

Either a list of parameters and their values, or a single value. See Details.

Internal parameters

The following parameters may also be specified to spatstat.options but are intended for software development or testing purposes.

Details

The function spatstat.options allows the user to examine and reset the values of global parameters which control actions in the spatstat package. It is analogous to the system function options.

The function reset.spatstat.options resets all the global parameters in spatstat to their original, default values.

The global parameters of interest to the user are:

If no arguments are given, the current values of all parameters are returned, in a list.

If one parameter name is given, the current value of this parameter is returned (not in a list, just the value). If several parameter names are given, the current values of these parameters are returned, in a list. If name=value pairs are given, the named parameters are reset to the given values, and the previous values of these parameters are returned, in a list.

See Also

options

Examples

  # save current values
  oldopt <- spatstat.options()

  spatstat.options("npixel")
  spatstat.options(npixel=150)
  spatstat.options(npixel=c(100,200))

  spatstat.options(par.binary=list(col=grey(c(0.5,1))))

  spatstat.options(par.persp=list(theta=-30,phi=40,d=4))
  # see help(persp.default) for other options

  # revert
  spatstat.options(oldopt)