registerModel {RPPASPACE}

Model Registration Methods

Description

These routines represent the high-level access for model registration, which enables data-driven access by other routines. This represents the initial implementation and may change in the future.

Usage

getRegisteredModel(key)
getRegisteredModelLabel(key)
getRegisteredModelKeys()
registerModel(key, classname, ui.label=names(key))

Arguments

key

character string representing a registered model

classname

character string specifying Model class name to register

ui.label

character string specifying label to display by UI

Value

getRegisteredModel returns the classname associated with key.

getRegisteredModelLabel returns the ui.label associated with key.

getRegisteredModelKeys returns vector of keys for all registered models.

registerModel is invoked for its side effect, which is registering classname and ui.label by association to key.

Author(s)

P. Roebuck [e-mail], James M. Melott [e-mail]

See Also

getRegisteredObject, getRegisteredObjectKeys, registerClassname

Examples

## Create new (but nonfunctional) fit model
## Not run due to lack of capability to unregister class
  ## Not run: 
setClass("TestFitClass",
         representation("FitClass",
                        testfit="character"),
         prototype(testfit="TestFitClass"))

## Register fit model to enable its use by package
registerModel("testfit", "TestFitClass", "Registered Test Fit Class")

## Show all registered fit models
sapply(getRegisteredModelKeys(),
       function(key) {
           c(model=getRegisteredModel(key),
             label=getRegisteredModelLabel(key))
       })
   
## End(Not run)