Performance improvements to parallel executions
[openmx:openmx.git] / man / mxRun.Rd
1 \name{mxRun}
2 \alias{mxRun}
3
4 \title{Send a Model to the Optimizer}
5
6 \description{
7    This function begins optimization on the top-level model.
8 }
9
10 \usage{
11 mxRun(model, silent=FALSE)
12 }
13
14 \arguments{
15     \item{model}{A \link{MxModel} object to be optimized.}
16     \item{silent}{A boolean indicating whether to print status to terminal.}
17 }
18
19 \details{
20 The mxRun function is used to optimize free parameters in \link{MxModel} objects based on an objective function. MxModel objects included in the mxRun function must include an appropriate objective function.
21
22 Free parameters are estimated or updated based on the objective function. These estimated values, along with estimation information and model fit, can be found in the 'output' slot of MxModel objects after mxRun has been used.
23
24 If a model is dependent on or shares parameters with another model, both models must be included as arguments in another MxModel object. This top-level MxModel object must include objective functions in both submodels, as well as an additional objective function describing how the results of the first two should be combined.
25 }
26
27 \value{
28    Returns an MxModel object with free parameters updated to their final values.
29    The return value contains an "output" slot with the results of 
30    optimization.
31 }
32
33 \references{
34 The OpenMx User's guide can be found at http://openmx.psyc.virginia.edu/documentation.
35 }
36
37 \examples{
38 #Create a model that includes data, matrices A, S and F, and an objective function
39 \dontrun{
40 data <- mxData(mydata, type="cov", numObs = 100)
41 objective <- mxRAMObjective('A', 'S', 'F')
42 model <- mxModel("mymodel", A, S, F, data, objective)
43
44 #Use mxRun to optimize the free parameters in the matrices A and S
45 model <- mxRun(model)
46
47 #print the output
48 model@output
49 }
50 }