getOptions function

Get and Set User Options

Get and Set User Options

Functions to get and set user options within an option class object.

getOptions(option.object, key) setOptions(option.object, ...)

Arguments

  • option.object: options class object used for storing package options
  • ...: any number of user options to set where either (a) the named argument is the option key and the value is the option value or (b) the single unnamed argument is a list object where each named list element is the option key and the value is the element's value
  • key: name of option to retrieve; if missing, all options are returned

Returns

Value of the option specified by key (if specified) or a list of all options (if missing).

Author(s)

Alex Couture-Beil, Vancouver Island University, Nanaimo BC

See Also

See PBSoptions-class for more details and an example that uses PBSmodelling's option management functions.