umxParameters: Display path estimates from a model, filtering by name and...

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

Display path estimates from a model, filtering by name and value.

Description

Often you want to see the estimates from a model, and often you don't want all of them. umxParameters() helps in this case, allowing you to select parameters matching a name filter, and also to only show parameters above or below a certain value.

If pattern is a vector, each regular expression is matched, and all unique matches to the whole vector are returned.

Usage

umxParameters(
  x,
  thresh = c("all", "above", "below", ">", "<", "NS", "sig"),
  b = NULL,
  pattern = ".*",
  std = FALSE,
  digits = 2
)

parameters(
  x,
  thresh = c("all", "above", "below", ">", "<", "NS", "sig"),
  b = NULL,
  pattern = ".*",
  std = FALSE,
  digits = 2
)

Arguments

x	an OpenMx::mxModel() or model summary from which to report parameter estimates.
thresh	optional: Filter out estimates 'below' or 'above' a certain value (default = "all").
b	Combine with thresh to set a minimum or maximum for which estimates to show.
pattern	Optional string to match in the parameter names. Default '.*' matches all. regex() allowed!
std	Standardize output: NOT IMPLEMENTED YET
digits	Round to how many digits (2 = default).

Details

It is on my TODO list to implement filtering by significance, and to add standardizing.

Value

• list of matching parameters, filtered by name and value

References

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

See Also

• umxGetParameters(), umxSummary(), namez()

Other Reporting Functions: umx, umxAPA(), umxFactorScores(), umxGetLatents(), umxGetManifests(), umxGetModel(), umxGetParameters(), umx_aggregate(), umx_time()

Examples

## Not run: 
require(umx)
data(demoOneFactor)
manifests = names(demoOneFactor)
m1 = umxRAM("OneFactor", data = demoOneFactor,
	umxPath(from = "G", to = manifests), # factor loadings
	umxPath(v.m. = manifests),           # residual variance
	umxPath(v1m0 = "G")                  # standardized latent
)
# Parameters with values below .1
umxParameters(m1, "below", .1)
# Parameters with values above .5
umxParameters(m1, "above", .5)
# Parameters with values below .1 and containing "_to_" in their label
umxParameters(m1, "below", .1, "_to_")

## End(Not run)

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