Revise man pages for mxRAMObjective, mxRObjective, and mxExpectationNormal. Add...
[openmx:openmx.git] / man / mxRObjective.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{mxRObjective}
17 \alias{mxRObjective}
18
19 \title{DEPRECATED: Create MxRObjective Object}
20
21 \description{
22    WARNING: Objective functions have been deprecated as of OpenMx 2.0.  Please use mxExpectationR() and mxFitFunctionML() instead.  As a temporary workaround, mxRObjective returns a list containing an MxExpectationR object and an MxFitFunctionML object.
23 }
24
25 \usage{
26    mxRObjective(objfun, ...)
27 All occurrences of
28
29 mxRObjective(objfun, ...)
30
31 Should be changed to
32
33 mxExpectationR(objfun, ...)
34 mxFitFunctionML(vector = FALSE)
35 }
36
37 \arguments{
38    \item{objfun}{A function that accepts two arguments.}
39    \item{...}{The initial state information to the objective function.}
40 }
41
42 \details{
43 NOTE: THIS DESCRIPTION IS DEPRECATED.  Please change to using \link{mxExpectationNormal} and \link{mxFitFunctionML} as shown in the example below.
44
45         The objfun argument must be a function that accepts two arguments. The first argument
46         is the mxModel that should be evaluated, and the second argument is some persistent 
47         state information that can be stored between one iteration of optimization to the next
48         iteration. It is valid for the function to simply ignore the second argument.
49
50         The function must return either a single numeric value, or a list of exactly two elements.
51         If the function returns a list, the first argument must be a single numeric value and the 
52         second element will be the new persistent state information to be passed into this function
53         at the next iteration. The single numeric value will be used by the optimizer to perform
54         optimization.
55
56         The initial default value for the persistant state information is NA.
57
58         Throwing an exception (via stop) from inside objfun may result
59         in unpredictable behavior. You may want to wrap your code in
60         tryCatch while experimenting.
61 }
62
63 \value{
64 Returns a list containing an mxExpectationR object and an MxFitFunctionML object. 
65 }
66
67 \references{
68 The OpenMx User's guide can be found at http://openmx.psyc.virginia.edu/documentation.
69 }
70
71 \examples{
72
73 # Create and fit a model using mxExpectationR, and mxFitFunctionML
74
75 library(OpenMx)
76
77 A <- mxMatrix(nrow = 2, ncol = 2, values = c(1:4), free = TRUE, name = 'A')
78 squared <- function(x) { x ^ 2 }
79
80 # Define the objective function in R
81
82 objFunction <- function(model, state) {
83         values <- model[['A']]@values 
84         return(squared(values[1,1] - 4) + squared(values[1,2] - 3) +
85                 squared(values[2,1] - 2) + squared(values[2,2] - 1))
86 }
87
88 # Define the expectation function
89
90 fitFunction <- mxFitFunctionR(objFunction)
91
92 # Define the model
93
94 tmpModel <- mxModel('exampleModel', A, fitFunction)
95
96 # Fit the model and print a summary
97
98 tmpModelOut <- mxRun(tmpModel)
99 summary(tmpModelOut)
100
101 }