umx (version 4.20.0)

umxAlgebra: A simple wrapper for mxAlgebra with name as the first parameter for more readable compact code.

Description

umxAlgebra is a wrapper for mxAlgebra which has the name parameter first in order.

Usage

umxAlgebra(
  name = NA,
  expression,
  dimnames = NA,
  ...,
  joinKey = as.character(NA),
  joinModel = as.character(NA),
  verbose = 0L,
  initial = matrix(as.numeric(NA), 1, 1),
  recompute = c("always", "onDemand"),
  fixed = "deprecated_use_recompute"
)

Value

• mxAlgebra()

Arguments

name

The name of the algebra (Default = NA). Note the different order compared to mxAlgebra!

expression

The algebra

dimnames

Dimnames of the algebra

...

Other parameters

joinKey

See mxAlgebra documentation

joinModel

See mxAlgebra documentation

verbose

Quiet or informative

initial

See mxAlgebra documentation

recompute

See mxAlgebra documentation

fixed

= See mxAlgebra documentation

See Also

• umxMatrix()

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

Examples

if (FALSE) {
A = umxMatrix("A", "Full", nrow = 3, ncol = 3, values=2)
B = umxAlgebra("B", A)
C = umxAlgebra(A + B, name = "C")
D = umxAlgebra(sin(C), name = "D")
m1 = mxRun(mxModel("AlgebraExample", A, B, C, D ))
mxEval(D, m1)
	
x = umxAlgebra("circ", expression = 2 * pi)
class(x$formula)
x = mxAlgebra(name = "circ", 2 * pi)
class(x$formula) # "call"
}