1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
%
% Copyright 2007-2019 by the individuals mentioned in the source code history
%
% Licensed under the Apache License, Version 2.0 (the "License");
% you may not use this file except in compliance with the License.
% You may obtain a copy of the License at
%
% http://www.apache.org/licenses/LICENSE-2.0
%
% Unless required by applicable law or agreed to in writing, software
% distributed under the License is distributed on an "AS IS" BASIS,
% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
% See the License for the specific language governing permissions and
% limitations under the License.
\name{omxGetParameters}
\alias{omxGetParameters}
\title{Fetch Model Parameters}
\description{
Return a vector of the chosen parameters from the model.
}
\usage{
omxGetParameters(model, indep = FALSE, free = c(TRUE, FALSE, NA),
fetch = c('values', 'free', 'lbound', 'ubound', 'all'),
labels = c())
}
\arguments{
\item{model}{a MxModel object}
\item{indep}{fetch parameters from independent submodels.}
\item{free}{fetch either free parameters (TRUE), or fixed parameters or both types. Default value is TRUE.}
\item{fetch}{which attribute of the parameters to fetch. Default choice is \sQuote{values}.}
\item{labels}{additional labels to fetch}
}
\details{
The argument \sQuote{free} dictates whether to return only free
parameters or only fixed parameters or both free and fixed
parameters. The function can return unlabeled free parameters
(parameters with a label of NA). These anonymous free parameters will
be identified as \sQuote{modelname.matrixname[row,col]}. It will not
return fixed parameters that have a label of NA.
If provided, the argument \sQuote{labels} takes precedent over the
selection criteria specified by \sQuote{free}. Any labels mentioned in
\sQuote{labels}, including those of the form
\sQuote{modelname.matrixname[row,col]}, will be returned.
No distinction is made between ordinary labels, definition variables, and square bracket constraints. The function will return either a vector of parameter values, or free/fixed designations, or lower bounds, or upper bounds, depending on the \sQuote{fetch} argument. Using fetch with \sQuote{all} returns a data frame that is populated with all of the attributes.
}
\seealso{
\code{\link{omxSetParameters}}, \code{\link{omxLocateParameters}}, \code{\link{omxAssignFirstParameters}}
}
\examples{
library(OpenMx)
A <- mxMatrix('Full', 2, 2, labels = c("A11", "A12", "A21", NA), values= 1:4,
free = c(TRUE,TRUE,FALSE,TRUE), byrow=TRUE, name = 'A')
model <- mxModel(A, name = 'model')
# Request all free parameters in model
omxGetParameters(model)
# A11 A12 model.A[2,2]
# 1 2 4
# Request fixed parameters from model
omxGetParameters(model, free = FALSE)
# A21
# 3
A$labels
# [,1] [,2]
# [1,] "A11" "A12"
# [2,] "A21" NA
A$free
# [,1] [,2]
# [1,] TRUE TRUE
# [2,] FALSE TRUE
A$values
# [,1] [,2]
# [1,] 1 2
# [2,] 3 4
# Example using un-labelled parameters
# Read in some demo data
data(demoOneFactor)
# Grab the names for manifestVars
manifestVars <- names(demoOneFactor)
nVar = length(manifestVars) # 5 variables
factorModel <- mxModel("One Factor",
mxMatrix(name="A", type="Full", nrow=nVar, ncol=1, values=0.2, free=TRUE,
lbound = 0.0, labels=letters[1:nVar]),
mxMatrix(name="L", type="Symm", nrow=1, ncol=1, values=1, free=FALSE),
# the "U" matrix has nVar (5) anonymous free parameters
mxMatrix(name="U", type="Diag", nrow=nVar, ncol=nVar, values=1, free=TRUE),
mxAlgebra(expression=A \%&\% L + U, name="R"),
mxExpectationNormal(covariance="R", dimnames=manifestVars),
mxFitFunctionML(),
mxData(observed=cov(demoOneFactor), type="cov", numObs=500)
)
# Get all free parameters
params <- omxGetParameters(factorModel)
lbound <- omxGetParameters(factorModel, fetch="lbound")
# Set new values for these params, saving them in a new model
newFactorModel <- omxSetParameters(factorModel, names(params), values = 1:10)
# Read out the values from the new model
newParams <- omxGetParameters(newFactorModel)
}
|
