umxRun: umxRun: Run an mxModel

View source: R/build_run_modify.R

umxRunR Documentation

umxRun: Run an mxModel

Description

umxRun is a version of OpenMx::mxRun() which can run also set start values, labels, and run multiple times It can also calculate the saturated and independence likelihoods necessary for most fit indices. Note this is not needed for umxRAM models or twin models - it is just a convenience to get base OpenMx models to run.

Usage

umxRun(
  model,
  tryHard = c("yes", "no", "ordinal", "search"),
  calc_sat = TRUE,
  setValues = FALSE,
  setLabels = FALSE,
  summary = !umx_set_silent(silent = TRUE),
  intervals = FALSE,
  optimizer = NULL,
  comparison = NULL
)

Arguments

model

The OpenMx::mxModel() you wish to run.

tryHard

How to tryHard. Default = "yes". Alternatives "no", "ordinal", "search"

calc_sat

Whether to calculate the saturated and independence models (for raw OpenMx::mxData() OpenMx::mxModel()s)

setValues

Whether to set the starting values of free parameters (default = FALSE)

setLabels

Whether to set the labels (default = FALSE)

summary

Whether to print summary or not (default = !umx_set_silent() )

intervals

Whether to run mxCI confidence intervals (default = FALSE) intervals = FALSE

optimizer

optional to set the optimizer.

comparison

Comparison model (will be used to drive umxCompare() after umxRun

Value

  • OpenMx::mxModel()

References

See Also

Other Advanced Model Building Functions: umx, umxAlgebra(), umxFixAll(), umxJiggle(), umxThresholdMatrix(), umxUnexplainedCausalNexus(), xmuLabel(), xmuValues()

Examples

## Not run: 
require(umx)
data(demoOneFactor)
latents  = c("G")
manifests = names(demoOneFactor)
m1 = mxModel("fact", type="RAM", manifestVars=manifests, latentVars=latents,
	mxPath(latents  , to = manifests),
	mxPath(manifests, arrows = 2),
	mxPath(latents  , arrows = 2, free = FALSE, values = 1),
	mxData(cov(demoOneFactor), type = "cov", numObs=500)
)

m1 = umxRun(m1) # just run: will create saturated model if needed
m1 = umxRun(m1, setValues = TRUE, setLabels = TRUE) # set start values and label all parameters
umxSummary(m1, std = TRUE)
m1 = mxModel(m1, mxCI("G_to_x1")) # add one CI
m1 = mxRun(m1, intervals = TRUE)
residuals(m1, run = TRUE) # get CIs on all free parameters
confint(m1) # OpenMx's SE-based CIs
umxConfint(m1, run = TRUE) # get likelihood-based CIs on all free parameters
m1 = umxRun(m1, tryHard = "yes")

## End(Not run)


tbates/umx documentation built on Dec. 14, 2024, 11:28 a.m.