Learn R Programming

PBSmodelling (version 2.70.2)

getOptions: Get and Set User Options

Description

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

Usage

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

Value

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

Arguments

option.object

options class object used for storing package options

key

name of option to retrieve; if missing, all options are returned

...

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

object

options class object used for storing package options

Author

Alex Couture-Beil, Software Engineer, Earthly Technologies, Victoria BC

Maintainer: Rowan Haigh, Program Head -- Offshore Rockfish
Pacific Biological Station (PBS), Fisheries & Oceans Canada (DFO), Nanaimo BC
locus opus: remote office, Vancouver BC
Last modified Rd: 2024-11-04

See Also

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