modelObjFit-class: Class '"modelObjFit"'

In modelObj: A Model Object Framework for Regression Analysis

Description

A class containing the fit results for a model object defined as an object of class modelObj.

Objects from the Class

Objects should not be created directly. Objects are created by a call to fit().

Slots

fitObj:

Value object of modeling function (i.e., class(fitObj)="lm" if solver.method=lm).

func:

Object of class methodObj the method to be used to obtain predicted values.

Methods

coef

signature(object = "modelObjFit"): if, defined for the modeling function, extracts model coefficients. Else, returns NULL.

fitObject

signature(object = "modelObjFit"): Retrieve fit object.

plot

signature(x = "modelObjFit", y=NULL): if defined for the modeling function, invokes plot(modelObj@fitObj). Else, returns a message that a plot(modelObj@fitObj) method is not defined.

predict

signature(object = "modelObjFit"): returns predicted values obtained using fitObj and the newdata data.frame.

predictor

signature(object = "modelObjFit"): Retrieve prediction method name.

predictorArgs

signature(object = "modelObjFit"): Retrieve arguments to be sent to prediction method.

residuals

signature(object = "modelObjFit"): if defined for the modeling function, returns the residuals(modelObjFit@fitObj).

show

signature(x = "modelObjFit"): displays standard results returned by modeling function.

summary

signature(x = "modelObjFit"): if, defined for the modeling function, returns summary(modelObjFit@fitObj). Else, returns a message that a summary(modelObjFit@fitObj) method is not defined.

Examples

showClass("modelObjFit")

Example output

Class "modelObjFit" [package "modelObj"]

Slots:
                        
Name:    fitObj modelObj
Class:      ANY modelObj

modelObj documentation built on May 2, 2019, 5:20 p.m.