PBSmodelling (version 2.69.3)

getOptionsPrefix: Get and Set GUI Prefix of Options Class

Description

The GUI prefix is used for determining which GUI variables are associated with a user option.

Usage

getOptionsPrefix(option.object)
setOptionsPrefix(option.object, prefix)

Value

getOptionsPrefix: a prefix string used to reference GUI variables

Arguments

option.object

options class object used for storing package options

prefix

new prefix to use

Author

Alex Couture-Beil, Vancouver Island University, Nanaimo BC

See Also

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

Examples

if (FALSE) {
local(envir=.PBSmodEnv,expr={
  # For the example, the options object is saved to the temporary environment;
  # however, a user would normally create the object in his/her workspace.
  .mypkg <- new( "PBSoptions", filename="my_pkg.txt", 
    initial.options=list(pi=3.14), gui.prefix="opt" )

  #prefix the option "pi" with "opt" to get "optpi"
  createWin( "entry name=optpi", astext = TRUE )

  #the GUI variable "optpi" will be loaded with the option "pi"
  loadOptionsGUI( .mypkg )
})
}