umx (version 1.4.0)

xmuLabel_Matrix: xmuLabel_Matrix (not a user function)

Description

This function will label all the free parameters in an mxMatrix

Usage

xmuLabel_Matrix(mx_matrix = NA, baseName = NA, setfree = FALSE, drop = 0, jiggle = NA, boundDiag = NA, suffix = "", verbose = TRUE, labelFixedCells = FALSE, overRideExisting = FALSE)

Arguments

mx_matrix

an mxMatrix

baseName

A base name for the labels NA

setfree

Whether to set free cells FALSE

drop

What values to drop 0

jiggle

= whether to jiggle start values

boundDiag

set diagonal element lbounds to this numeric value (default = NA = ignore)

suffix

a string to append to each label

verbose

how much feedback to give

labelFixedCells

= FALSE

overRideExisting

Whether to overRideExisting (Default FALSE)

Value

- The labeled mxMatrix

Details

End users should just call umxLabel

Purpose: label the cells of an mxMatrix Detail: Defaults to the handy "matrixname_r1c1" where 1 is the row or column Use case: You should not use this: call umxLabel umx:::xmuLabel_Matrix(mxMatrix("Lower", 3, 3, values = 1, name = "a", byrow = TRUE), jiggle = .05, boundDiag = NA); umx:::xmuLabel_Matrix(mxMatrix("Full" , 3, 3, values = 1, name = "a", byrow = TRUE)); umx:::xmuLabel_Matrix(mxMatrix("Symm" , 3, 3, values = 1, name = "a", byrow = TRUE), jiggle = .05, boundDiag = NA); umx:::xmuLabel_Matrix(mxMatrix("Full" , 1, 1, values = 1, name = "a", labels= "data.a")); umx:::xmuLabel_Matrix(mxMatrix("Full" , 1, 1, values = 1, name = "a", labels= "data.a"), overRideExisting = TRUE); umx:::xmuLabel_Matrix(mxMatrix("Full" , 1, 1, values = 1, name = "a", labels= "test"), overRideExisting = TRUE); See also: fit2 = omxSetParameters(fit1, labels = "a_r1c1", free = FALSE, value = 0, name = "drop_a_row1_c1")

See Also

Other xmu internal not for end user: umx_explode_twin_names, xmuHasSquareBrackets, xmuLabel_MATRIX_Model, xmuLabel_RAM_Model, xmuMI, xmuMakeDeviationThresholdsMatrices, xmuMakeOneHeadedPathsFromPathList, xmuMakeTwoHeadedPathsFromPathList, xmuMaxLevels, xmuMinLevels, xmuPropagateLabels, xmu_check_levels_identical, xmu_dot_make_paths, xmu_dot_make_residuals, xmu_start_value_list