1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
|
%% "FIXME" --- move this to stats4
\name{Model-class}
\title{Mother Class "Model" of all S4 Models}
\docType{class}
\alias{Model-class}
\alias{formula,Model-method}
\alias{update,Model-method}
\description{
Class \code{"Model"} is meant to be the mother class of all (S4) model
classes.
As some useful methods are already defined for \code{"Model"} objects,
derived classes inherit those \dQuote{for free}.
}
\section{Objects from the Class}{A virtual Class: No objects may be created from it.}
\section{Slots}{
\describe{
\item{\code{call}:}{the \code{\link{call}} which generated the model.}
\item{\code{fitProps}:}{a \code{\link{list}}; must be named,
i.e., have unique \code{\link{names}}, but can be empty.
When the main object is a \emph{fitted} model, the list will
typically have components such as \code{iter} (non-negative
integer) and \code{convergenece} (\code{\link{logical}} typically).
}
}
}
\section{Methods}{
\describe{
\item{formula}{\code{signature(x = "Model")}: extract the model
formula - if there is one, or \code{\link{NULL}}.}
\item{update}{\code{signature(object = "Model")}: Update the model
with a new formula, new data, \dots\dots etc. This semantically
equivalent (and as \R function almost identical) to the standard
\code{\link[stats]{update}} (package \pkg{stats}).}
}
}
\seealso{% as this will move to 'stats4':
the \code{\link[MatrixModels:glpModel-class]{glpModel}} class in package
\pkg{MatrixModels} which extends this class.
}
\examples{
showClass("Model")
}
\keyword{classes}
|
