Added more documentation, and changed mxFOO() functions such
[openmx:openmx.git] / man / MxModel-class.Rd
1 \name{MxModel-class}
2 \alias{MxModel}
3
4 \title{MxModel Class}
5
6 \description{
7    MxModel is an S4 class. An MxModel object is a \link[=Named-entity]{named entity}.
8    New instances of this class can be created using the function \link{mxModel}.
9 }
10
11 \details{
12   The MxModel class has the following slots:
13
14   \tabular{rcl}{
15         \tab \tab \cr
16         name \tab - \tab The name of the object \cr
17         matrices \tab - \tab A list of \link{MxMatrix} objects \cr
18         algebras \tab - \tab A list of \link{MxAlgebra} objects \cr
19         submodels \tab - \tab A list of MxModel objects \cr
20         constraints \tab - \tab A list of MxConstraint objects \cr
21         bounds \tab - \tab A list of MxBounds objects \cr
22         paths \tab - \tab A data frame of paths \cr
23         latentVars \tab - \tab A list of latent variables \cr
24         manifestVars \tab - \tab A list of manifest variables \cr
25         data \tab - \tab A \link{MxData} object \cr
26         objective \tab - \tab Either NULL or a MxObjective object \cr
27         independent \tab - \tab TRUE if-and-only-if the model is independent \cr
28         output \tab - \tab A list with optimization results
29   }
30 }