Added a help page for mxCompare() ... someone please check it for sanity and truthiness
[openmx:openmx.git] / man / mxCompare.Rd
1 \name{mxCompare}
2 \alias{mxCompare}
3
4 \title{Assign Model Parameters}
5
6 \description{
7     Compare the fit of one or more models to a base model.
8     The output is a table with one row per model comparison, and the following columns: 
9          base  - Name of the base model
10          name  - Name of the model model being compared on this line
11          ep    - Estimated parameters of the comparison model
12          -2LL  - minus 2*log-likelihood of the current model
13          df    - Change in degrees of freedom
14         AIC    - Akaike's Information Criterion for the comparison
15        diffLL  - Change in minus 2* log-likelihood
16        diffdf  - Change in degrees of freedom
17        p       - Significance level of the change in fit
18 }
19
20 \usage{
21 omxCompare(base,comparison,digits=3)
22 }
23
24 \arguments{
25    \item{base}{an MxModel object.}
26    \item{comparison}{a vector of one or more nested MxModel objects}
27    \item{digits}{a numeric setting table decimal precision.} 
28 }
29
30 \seealso{
31 \code{\link{mxModel}} 
32 }
33
34 \examples{
35
36 require(OpenMx)
37 data(demoOneFactor)
38 manifests <- names(demoOneFactor)
39 latents <- c("G1")
40 model1 <- mxModel("One Factor", type="RAM",
41       manifestVars = manifests,
42       latentVars = latents,
43       mxPath(from=latents, to=manifests),
44       mxPath(from=manifests, arrows=2),
45       mxPath(from=latents, arrows=2, free=F, values=1.0),
46       mxData(cov(demoOneFactor), type="cov",numObs=500)
47 )
48 fit1 = mxRun(model1)
49
50 latents <- c("G1","G2")
51 model2 <- mxModel("Two Factor", type="RAM",
52       manifestVars = manifests,
53       latentVars = latents,
54       mxPath(from=latents[1], to=manifests[1:3]),
55       mxPath(from=latents[2], to=manifests[4:5]),
56       mxPath(from=manifests, arrows=2),
57       mxPath(from=latents, arrows=2, free=F, values=1.0),
58       mxData(cov(demoOneFactor), type="cov",numObs=500)
59 )
60 fit2 = mxRun(model2)
61
62 mxCompare(fit1, c(fit2,fit3), digits=3)
63 #         base comparison ep minus2LL df  AIC diffLL diffdf p
64 # 1 One Factor Two Factor 10    -2450  5 1200   1200      0 0
65 }