Added R help files for mxFitFunctionR and mxFitFunctionRow. Deprecated mxRObjective...
[openmx:openmx.git] / man / mxFitFunctionR.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{mxFitFunctionR}
17 \alias{mxFitFunctionR}
18
19 \title{Create MxFitFunctionR Object}
20
21 \description{
22 mxFitFunctionR returns an MxFitFunctionR object.
23 }
24
25 \usage{
26 mxFitFunctionR(objfun, ...)
27 }
28
29 \arguments{
30    \item{objfun}{A function that accepts two arguments.}
31    \item{...}{The initial state information to the objective function.}
32 }
33
34 \details{
35 The mxFitFunctionR function evaluates a user-defined R function called the 'objfun'.  mxFitFunctionR is useful in defining new mxFitFunctions, since any calculation that can be performed in R can be treated as an mxFitFunction.
36
37 The 'objfun' argument must be a function that accepts two arguments. The first argument
38 is the mxModel that should be evaluated, and the second argument is some persistent 
39 state information that can be stored between one iteration of optimization to the next
40 iteration. It is valid for the function to simply ignore the second argument.
41
42 The function must return either a single numeric value, or a list of exactly two elements.
43 If the function returns a list, the first argument must be a single numeric value and the 
44 second element will be the new persistent state information to be passed into this function
45 at the next iteration. The single numeric value will be used by the optimizer to perform
46 optimization.
47
48 The initial default value for the persistant state information is NA.
49
50 Throwing an exception (via stop) from inside objfun may result
51 in unpredictable behavior. You may want to wrap your code in
52 tryCatch while experimenting.
53 }
54
55 \value{
56 Returns an MxFitFunctionR object. 
57 }
58
59 \references{
60 The OpenMx User's guide can be found at http://openmx.psyc.virginia.edu/documentation.
61 }
62
63 \examples{
64
65 # Create and fit a model using mxFitFunctionR
66
67 library(OpenMx)
68
69 A <- mxMatrix(nrow = 2, ncol = 2, values = c(1:4), free = TRUE, name = 'A')
70 squared <- function(x) { x ^ 2 }
71
72 # Define the objective function in R
73
74 objFunction <- function(model, state) {
75     values <- model[['A']]@values 
76     return(squared(values[1,1] - 4) + squared(values[1,2] - 3) +
77         squared(values[2,1] - 2) + squared(values[2,2] - 1))
78 }
79
80 # Define the expectation function
81
82 fitFunction <- mxFitFunctionR(objFunction)
83
84 # Define the model
85
86 tmpModel <- mxModel('exampleModel', A, fitFunction)
87
88 # Fit the model and print a summary
89
90 tmpModelOut <- mxRun(tmpModel)
91 summary(tmpModelOut)
92
93 }