umx: umxGetParameters – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

umxGetParameters

Get parameters from a model, with support for pattern matching!

Description

umxGetParameters retrieves parameter labels from a model, like omxGetParameters(). However, it is supercharged with regular expressions, so you can get labels that match a pattern.

Usage

umxGetParameters(
  inputTarget,
  regex = NA,
  free = NA,
  fetch = c("labels", "values", "free", "lbound", "ubound", "all"),
  verbose = FALSE
)

Arguments

`inputTarget`	An object to get parameters from: could be a RAM `mxModel()`
`regex`	A regular expression to filter the labels. Default (NA) returns all labels. If vector, treated as raw labels to find.
`free`	A Boolean determining whether to return only free parameters.
`fetch`	What to return: "labels" (default) or "values", "free", "lbound", "ubound", or "all"
`verbose`	How much feedback to give

Details

In addition, if regex contains a vector, this is treated as a list of raw labels to search for, and return if all are found. note: To return all labels, just leave regex as is.

References

https://github.com/tbates/umx

Examples

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)
)

# Show all parameters
umxGetParameters(m1)
umxGetParameters(m1, free = TRUE)  # Only free parameters
umxGetParameters(m1, free = FALSE) # Only fixed parameters
# Complex regex pattern
umxGetParameters(m1, regex = "x[1-3]_with_x[2-5]", free = TRUE)

umx

Structural Equation Modeling and Twin Modeling in R

v4.10.10

GPL-3

Authors

Timothy C. Bates [aut, cre] (<https://orcid.org/0000-0002-1153-9007>), Gillespie Nathan [wit], Michael Zakharin [wit], Brenton Wiernik [ctb], Joshua N. Pritikin [ctb], Michael C. Neale [ctb], Hermine Maes [ctb]

Initial release

2021-11-30