umx_check_model: Check for required features in an OpenMx.

In tbates/umx: Structural Equation Modeling and Twin Modeling in R

Check for required features in an OpenMx.

Description

Allows the user to straight-forwardly require a specific model type (i.e., "RAM", "LISREL", etc.), whether or not the model has data, if it has been run or not. You can also test whether is has a means model or not and (in future) test if it has submodels.

Usage

umx_check_model(
  obj,
  type = NULL,
  hasData = NULL,
  beenRun = NULL,
  hasMeans = NULL,
  checkSubmodels = FALSE,
  callingFn = "a function"
)

Arguments

obj	an object to check
type	what type the model must be, i.e., "RAM", "LISREL", etc. (defaults to not checking NULL)
hasData	whether the model should have data or not (defaults to not checking NULL)
beenRun	whether the model has been run or not (defaults to not checking NULL)
hasMeans	whether the model should have a means model or not (defaults to not checking NULL)
checkSubmodels	whether to check submodels (not implemented yet) (default = FALSE)
callingFn	= Name of the calling function to help the user locate the error.

Value

- boolean

References

- <https://github.com/tbates/umx>

See Also

Other Test: umx_check(), umx_check_OS(), umx_check_names(), umx_check_parallel(), umx_has_CIs(), umx_has_been_run(), umx_has_means(), umx_has_square_brackets(), umx_is_MxData(), umx_is_MxMatrix(), umx_is_MxModel(), umx_is_RAM(), umx_is_cov()

Examples

## Not run: 
require(umx)
data(demoOneFactor)
manifests = names(demoOneFactor)
m1 = umxRAM("check_model_ex", data = demoOneFactor, type = "cov",
	umxPath("G", to = manifests),
	umxPath(var = manifests),
	umxPath(var = "G", fixedAt = 1)
)
umx_check_model(m1) # TRUE, this is a model
umx_check_model(m1, type = "RAM") # equivalent to umx_is_RAM()
umx_check_model(m1, hasData = TRUE)


umx_check_model(m1, hasMeans = TRUE)
umx_check_model(m1, beenRun = FALSE)
# Model with no data
m1 = umxRAM("x ~~ .3*y", autoRun = FALSE)
umx_check_model(m1, hasData = TRUE)

## End(Not run)

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