Add R help for mxExpecationLISREL and editing changes to a few other help files.
[openmx:openmx.git] / man / mxRAMObjective.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{mxRAMObjective}
17 \alias{mxRAMObjective}
18
19 \title{DEPRECATED: Create MxRAMObjective Object}
20
21 \description{
22 WARNING: Objective functions have been deprecated as of OpenMx 2.0.  
23    
24 Please use mxExpectationRAM() and mxFitFunctionML() instead.  As a temporary workaround, mxRAMObjective returns a list containing an MxExpectationNormal object and an MxFitFunctionML object.}
25
26 \usage{
27 All occurrences of
28
29 mxRAMObjective(A, S, F, M = NA, dimnames = NA, thresholds = NA, vector = FALSE, threshnames = dimnames)
30
31 Should be changed to
32
33 mxExpectationRAM(A, S, F, M = NA, dimnames = NA, thresholds = NA, threshnames = dimnames)
34 mxFitFunctionML(vector = FALSE)
35 }
36
37
38 \arguments{
39    \item{A}{A character string indicating the name of the 'A' matrix.}
40    \item{S}{A character string indicating the name of the 'S' matrix.}
41    \item{F}{A character string indicating the name of the 'F' matrix.}
42    \item{M}{An optional character string indicating the name of the 'M' matrix.}
43    \item{dimnames}{An optional character vector to be assigned to the column names of the 'F' and 'M' matrices.}   
44    \item{thresholds}{An optional character string indicating the name of the thresholds matrix.}
45    \item{vector}{A logical value indicating whether the objective function result is the likelihood vector.}
46    \item{threshnames}{An optional character vector to be assigned to the column names of the thresholds matrix.}
47 }
48
49 \details{
50 NOTE: THIS DESCRIPTION IS DEPRECATED.  Please change to using \link{mxExpectationRAM} and \link{mxFitFunctionML} as shown in the example below.
51
52 Objective functions were functions for which free parameter values are chosen such that the value of the objective function was minimized. The mxRAMObjective provided maximum likelihood estimates of free parameters in a model of the covariance of a given \link{MxData} object. This model is defined by reticular action modeling (McArdle and McDonald, 1984). The 'A', 'S', and 'F' arguments must refer to \link{MxMatrix} objects with the associated properties of the A, S, and F matrices in the RAM modeling approach.
53
54 The 'dimnames' arguments takes an optional character vector.  If this argument is not a single NA, then this vector be assigned to be the column names of the 'F' matrix and optionally to the 'M' matrix, if the 'M' matrix exists.
55
56 The 'A' argument refers to the A or asymmetric matrix in the RAM approach. This matrix consists of all of the asymmetric paths (one-headed arrows) in the model. A free parameter in any row and column describes a regression of the variable represented by that row regressed on the variable represented in that column. 
57
58 The 'S' argument refers to the S or symmetric matrix in the RAM approach, and as such must be square. This matrix consists of all of the symmetric paths (two-headed arrows) in the model. A free parameter in any row and column describes a covariance between the variable represented by that row and the variable represented by that column. Variances are covariances between any variable at itself, which occur on the diagonal of the specified matrix.
59
60 The 'F' argument refers to the F or filter matrix in the RAM approach. If no latent variables are included in the model (i.e., the A and S matrices are of both of the same dimension as the data matrix), then the 'F' should refer to an identity matrix. If latent variables are included (i.e., the A and S matrices are not of the same dimension as the data matrix), then the 'F' argument should consist of a horizontal adhesion of an identity matrix and a matrix of zeros. 
61
62 The 'M' argument refers to the M or means matrix in the RAM approach.  It is a 1 x n matrix, where n is the number of manifest variables + the number of latent variables. The M matrix must be specified if either the mxData type is \dQuote{cov} or \dQuote{cor} and a means vector is provided, or if the mxData type is \dQuote{raw}.  Otherwise the M matrix is ignored.
63
64 The \link{MxMatrix} objects included as arguments may be of any type, but should have the properties described above. The mxRAMObjective will not return an error for incorrect specification, but incorrect specification will likely lead to estimation problems or errors in the \link{mxRun} function.
65
66 mxRAMObjective evaluates with respect to an \link{MxData} object. The \link{MxData} object need not be referenced in the mxRAMObjective function, but must be included in the \link{MxModel} object. mxRAMObjective requires that the 'type' argument in the associated \link{MxData} object be equal to 'cov' or 'cor'.
67
68 To evaluate, place MxRAMObjective objects, the \link{mxData} object for which the expected covariance approximates, referenced \link{MxAlgebra} and \link{MxMatrix} objects, and optional \link{MxBounds} and \link{MxConstraint} objects in an \link{MxModel} object. This model may then be evaluated using the \link{mxRun} function. The results of the optimization can be found in the 'output' slot of the resulting model, and may be obtained using the \link{mxEval} function..
69 }
70
71 \value{
72 Returns a list containing an MxExpectationRAM object and an MxFitFunctionML object. 
73 }
74
75 \references{
76 McArdle, J. J. and MacDonald, R. P. (1984). Some algebraic properties of the Reticular Action Model for moment structures. \emph{British Journal of Mathematical and Statistical Psychology, 37,} 234-251.
77
78 The OpenMx User's guide can be found at http://openmx.psyc.virginia.edu/documentation.
79 }
80
81 \examples{
82    
83
84 # Create and fit a model using mxMatrix, mxAlgebra, mxExpectationNormal, and mxFitFunctionML
85
86 library(OpenMx)
87
88 # Simulate some data
89
90 x=rnorm(1000, mean=0, sd=1)
91 y= 0.5*x + rnorm(1000, mean=0, sd=1)
92 tmpFrame <- data.frame(x, y)
93 tmpNames <- names(tmpFrame)
94
95 # Define the matrices
96
97 matrixS <- mxMatrix(type = "Full", nrow = 2, ncol = 2, values=c(1,0,0,1), 
98               free=c(TRUE,FALSE,FALSE,TRUE), labels=c("Vx", NA, NA, "Vy"), name = "S")
99 matrixA <- mxMatrix(type = "Full", nrow = 2, ncol = 2, values=c(0,1,0,0), 
100               free=c(FALSE,TRUE,FALSE,FALSE), labels=c(NA, "b", NA, NA), name = "A")
101 matrixF <- mxMatrix(type="Iden", nrow=2, ncol=2, name="F")
102 matrixM <- mxMatrix(type = "Full", nrow = 1, ncol = 2, values=c(0,0), 
103               free=c(TRUE,TRUE), labels=c("Mx", "My"), name = "M")
104
105 # Define the expectation
106
107 expFunction <- mxExpectationRAM(M="M", dimnames = tmpNames)
108
109 # Choose a fit function
110
111 fitFunction <- mxFitFunctionML()
112
113 # Define the model
114
115 tmpModel <- mxModel("exampleRAMModel", matrixA, matrixS, matrixF, matrixM, expFunction, fitFunction, 
116                     mxData(observed=tmpFrame, type="raw"))
117
118 # Fit the model and print a summary
119
120 tmpModelOut <- mxRun(tmpModel)
121 summary(tmpModelOut)
122 }