You are here

Revision of omxsetparameters from Fri, 07/09/2010 - 06:30

Revisions allow you to track differences between multiple versions of your content, and revert back to older versions.

omxSetParameters

Wiki home page

list: ol; title: Table of Contents; minlevel: 1; maxlevel: 3; attachments: 1;

Usage

Very handy function to modify the attributes of matrix cells in a model.

omxSetParameters(model, labels, free = NULL, values = NULL, newlabels = NULL, lbound = NULL, ubound = NULL, indep = FALSE)

Arguments

model a MxModel object.
labels a character vector of target parameter names.
free a boolean vector of parameter free/fixed designations.
values a numeric vector of parameter values.
newlabels a character vector of new parameter names.
lbound a numeric vector of lower bound values.
ubound a numeric vector of upper bound values.
indep boolean. set parameters in independent submodels.

Examples

    A     <- mxMatrix('Full', nrow=3, ncol=3, labels = c('a','b', NA), free = TRUE, name = 'A') # labels for row 1 and 2, row 3 left unalabelled
    model <- mxModel(A, name = 'model')

    model@matrices$A@labels
         [,1] [,2] [,3]
    [1,] "a"  "a"  "a" 
    [2,] "b"  "b"  "b" 
    [3,] NA   NA   NA  

    model <- omxSetParameters(model, c('a', 'b'), values = c(1, 2)) # set value of cells labelled "a" and "b" to 1 and 2 respectively
    model <- omxSetParameters(model, c('a', 'b'), newlabels = c('b', 'a')) # set label of cell labelled "a" to "b" and vice versa
    
    # See the results...

    model@matrices$A
    @labels
         [,1] [,2] [,3]
    [1,] "b"  "b"  "b" 
    [2,] "a"  "a"  "a" 
    [3,] NA   NA   NA  

    @values
         [,1] [,2] [,3]
    [1,]    1    1    1
    [2,]    2    2    2
    [3,]    0    0    0

Gotchas

This function cannot modify parameters that have NA labels (i,e, label your matrix cells if you want to use this to set and drop parameters.

See Also

omxGetParameters, omxAssignFirstParameters

Please add material here as you learn... If you have questions not answers, then add those here: That's how a wiki works.