mxBounds {OpenMx} | R Documentation |
Create MxBounds Object
Description
This function creates a new MxBounds object.
Usage
mxBounds(parameters, min = NA, max = NA)
Arguments
parameters |
A character vector indicating the names of the parameters on which to apply bounds. |
min |
A numeric value for the lower bound. NA means use default value. |
max |
A numeric value for the upper bound. NA means use default value. |
Details
Creates a set of boundaries or limits for a parameter or set of parameters. Parameters may be any free parameter or parameters from an MxMatrix object. Parameters may be referenced either by name or by referring to their position in the 'spec' matrix of an MxMatrix
object.
Minima and maxima may be specified as scalar numeric values.
Value
Returns a new MxBounds object. If used as an argument in an MxModel object, the parameters referenced in the 'parameters' argument must also be included prior to optimization.
References
The OpenMx User's guide can be found at https://openmx.ssri.psu.edu/documentation/.
See Also
MxBounds for the S4 class created by mxBounds. MxMatrix and mxMatrix for free parameter specification. More information about the OpenMx package may be found here.
Examples
#Create lower and upper bounds for parameters 'A' and 'B'
bounds <- mxBounds(c('A', 'B'), 3, 5)
#Create a lower bound of zero for a set of variance parameters
varianceBounds <- mxBounds(c('Var1', 'Var2', 'Var3'), 0)