Revise man pages for mxRAMObjective, mxRObjective, and mxExpectationNormal. Add...
[openmx:openmx.git] / man / mxExpectationNormal.Rd
1 %
2 %   Copyright 2007-2013 The OpenMx Project
3 %
4 %   Licensed under the Apache License, Version 2.0 (the "License");
5 %   you may not use this file except in compliance with the License.
6 %   You may obtain a copy of the License at
7
8 %        http://www.apache.org/licenses/LICENSE-2.0
9
10 %   Unless required by applicable law or agreed to in writing, software
11 %   distributed under the License is distributed on an "AS IS" BASIS,
12 %   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 %   See the License for the specific language governing permissions and
14 %   limitations under the License.
15
16 \name{mxFIMLObjective}
17 \alias{mxFIMLObjective}
18
19 \title{Create MxFitFunctionML Object}
20
21 \description{
22    This function creates an MxExpectationNormal object.
23 }
24
25 \usage{
26 mxExpectationNormal(covariance, means, dimnames = NA, thresholds = NA, threshnames = dimnames)
27 }
28
29 \arguments{
30    \item{covariance}{A character string indicating the name of the expected covariance algebra.}
31    \item{means}{A character string indicating the name of the expected means algebra.}
32    \item{dimnames}{An optional character vector to be assigned to the dimnames of the covariance and means algebras.}
33    \item{thresholds}{An optional character string indicating the name of the thresholds matrix.}
34    \item{threshnames}{An optional character vector to be assigned to the column names of the thresholds matrix.}
35 }
36
37 \details{
38 Expectation functions define the way that model expectations are calculated. The mxExpectationNormal function uses the algebra defined by the 'covariance' and 'means' arguments to define the expected covariance and means under the assumption of multivariate normality. The 'covariance' argument takes an \link{MxAlgebra} object, which defines the expected covariance of an associated \link{MxData} object. The 'means' argument takes an \link{MxAlgebra} object, which defines the expected means of an associated \link{MxData} object. The 'dimnames' arguments takes an optional character vector.  If this argument is not a single NA, then this vector is used to assign the dimnames of the means vector as well as the row and columns dimnames of the covariance matrix.
39
40 thresholds: The name of the thresholds matrix. When needed (for modelling ordinal data), this matrix should be created using  \link{mxMatrix}(). The thresholds matrix must have as many columns as there are ordinal variables in the model, and number of rows equal to one fewer than the maximum number of levels found in the ordinal variables. The starting values  of this matrix must also be set to reasonable values. Fill each column with a set of ordered start thresholds, one for each level of this column's factor levels minus 1. These thresholds may be free if you wish them to be estimated, or fixed. The unused rows in each column, if any, can be set to any value including NA.
41
42 threshnames: A character vector consisting of the variables in the thresholds matrix, i.e., the names of ordinal variables in a model. This is necessary for OpenMx to map the thresholds matrix columns onto the variables in your data. If you set the \link{dimnames} of the columns in the thresholds matrix then threshnames is not needed.
43
44 Usage Notes: 
45 dimnames must be supplied where the matrices referenced by the covariance and means algebras are not themselves labeled. Failure to do so leads to an error noting that the covariance or means matrix associated with the FIML objective does not contain dimnames.
46
47 mxExpectationNormal evaluates with respect to an \link{MxData} object. The \link{MxData} object need not be referenced in the mxExpectationNormal function, but must be included in the \link{MxModel} object. When the 'type' argument in the associated \link{MxData} object is equal to 'raw', missing values are permitted in the associated \link{MxData} object.
48
49 To evaluate, place an mxExpectationNormal object, the \link{mxData} object for which the expected covariance approximates, referenced \link{MxAlgebra} and \link{MxMatrix} objects, optional \link{MxBounds} or \link{MxConstraint} objects, and an mxFitFunction such as \link{mxFitFunctionML} in an \link{MxModel} object. This model may then be evaluated using the \link{mxRun} function. 
50
51 The results of the optimization can be reported using the \link{summary} function, or accessed directly in the 'output' slot of the resulting model (i.e., modelName@output). Components of the output may be referenced using the \link{Extract} functionality.
52 }
53
54 \value{
55 Returns an MxExpectationNormal object. 
56 }
57
58 \references{
59 The OpenMx User's guide can be found at http://openmx.psyc.virginia.edu/documentation.
60 }
61
62 \examples{
63
64 # Create and fit a model using mxMatrix, mxAlgebra, mxExpectationNormal, and mxFitFunctionML
65
66 library(OpenMx)
67
68 # Simulate some data
69
70 x=rnorm(1000, mean=0, sd=1)
71 y= 0.5*x + rnorm(1000, mean=0, sd=1)
72 tmpFrame <- data.frame(x, y)
73 tmpNames <- names(tmpFrame)
74
75 # Define the matrices
76
77 M <- mxMatrix(type = "Full", nrow = 1, ncol = 2, values=c(0,0), 
78               free=c(TRUE,TRUE), labels=c("Mx", "My"), name = "M")
79 S <- mxMatrix(type = "Full", nrow = 2, ncol = 2, values=c(1,0,0,1), 
80               free=c(TRUE,FALSE,FALSE,TRUE), labels=c("Vx", NA, NA, "Vy"), name = "S")
81 A <- mxMatrix(type = "Full", nrow = 2, ncol = 2, values=c(0,1,0,0), 
82               free=c(FALSE,TRUE,FALSE,FALSE), labels=c(NA, "b", NA, NA), name = "A")
83 I <- mxMatrix(type="Iden", nrow=2, ncol=2, name="I")
84
85 # Define the expectation
86
87 expCov <- mxAlgebra(solve(I-A) \%*\% S \%*\% t(solve(I-A)), name="expCov")
88 expFunction <- mxExpectationNormal(covariance="expCov", means="M", dimnames=tmpNames)
89
90 # Choose a fit function
91
92 fitFunction <- mxFitFunctionML()
93
94 # Define the model
95
96 tmpModel <- mxModel("exampleModel", M, S, A, I, expCov, expFunction, fitFunction, 
97                     mxData(observed=tmpFrame, type="raw"))
98
99 # Fit the model and print a summary
100
101 tmpModelOut <- mxRun(tmpModel)
102 summary(tmpModelOut)
103
104
105 }