umx (version 4.0.0)

residuals.MxModel: Get residuals from an MxModel

Description

Return the residuals() from an OpenMx RAM model. You can format these (with digits), and suppress small values.

Usage

# S3 method for MxModel
residuals(object, digits = 2, suppress = NULL, reorder = NULL, ...)

Arguments

object

An fitted mxModel() from which to get residuals

digits

round to how many digits (default = 2)

suppress

smallest deviation to print out (default = NULL = show all)

reorder

optionally reorder the variables in the residuals matrix to show patterns

...

Optional parameters

Value

• matrix of residuals

References

• https://tbates.github.io, https://github.com/tbates/umx

See Also

Other Reporting functions: RMSEA.MxModel(), RMSEA.summary.mxmodel(), RMSEA(), extractAIC.MxModel(), loadings(), umxCI_boot(), umxCI(), umxCompare(), umxConfint(), umxExpCov(), umxExpMeans(), umxFitIndices(), umxPlotACEv(), umxRotate(), umxSummary.MxModel()

Examples

# NOT RUN {
require(umx)
data(demoOneFactor)
manifests = names(demoOneFactor)

m1 = umxRAM("One Factor", data = demoOneFactor, type = "cov",
	umxPath("G", to = manifests),
	umxPath(var = manifests),
	umxPath(var = "G", fixedAt = 1.0)
)

# ===================================
# = Show the residuals of the model =
# ===================================
residuals(m1)
# |   |x1   |x2    |x3   |x4    |x5 |
# |:--|:----|:-----|:----|:-----|:--|
# |x1 |.    |.     |0.01 |.     |.  |
# |x2 |.    |.     |0.01 |-0.01 |.  |
# |x3 |0.01 |0.01  |.    |.     |.  |
# |x4 |.    |-0.01 |.    |.     |.  |
# |x5 |.    |.     |.    |.     |.  |
# [1] "nb: You can zoom in on bad values with, e.g. suppress = .01, which
#      will hide values smaller than this. Use digits = to round"

residuals(m1, digits = 3)
residuals(m1, digits = 3, suppress = .005)
# residuals are returned as an invisible object you can capture in a variable
a = residuals(m1); a
# }