Mother Class "Model" of all S4 Models

Description

Class "Model" is meant to be the mother class of all (S4) model classes. As some useful methods are already defined for "Model" objects, derived classes inherit those “for free”.

Objects from the Class

A virtual Class: No objects may be created from it.

Slots

call:

the call which generated the model.

fitProps:

a list; must be named, i.e., have unique names, but can be empty.

When the main object is a fitted model, the list will typically have components such as iter (non-negative integer) and convergenece (logical typically).

Methods

formula

signature(x = "Model"): extract the model formula - if there is one, or NULL.

update

signature(object = "Model"): Update the model with a new formula, new data, ...... etc. This semantically equivalent (and as R function almost identical) to the standard update (package stats).

See Also

the glpModel class in package MatrixModels which extends this class.

Examples

showClass("Model")

Results

R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(MatrixModels)
> png(filename="/home/ddbj/snapshot/RGM3/R_CC/result/MatrixModels/Model-class.Rd_%03d_medium.png", width=480, height=480)
> ### Name: Model-class
> ### Title: Mother Class "Model" of all S4 Models
> ### Aliases: Model-class formula,Model-method update,Model-method
> ### Keywords: classes
> 
> ### ** Examples
> 
> showClass("Model")
Virtual Class "Model" [package "MatrixModels"]

Slots:
                        
Name:      call fitProps
Class:     call     list

Known Subclasses: "glpModel"
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>