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
|
%
% Copyright 2007-2021 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{omxLocateParameters}
\alias{omxLocateParameters}
\title{Get the location (model, matrix, row, column) and other info for a parameter}
\description{
Returns a data.frame summarizing the \emph{free} parameters in a model,
possibly filtered using \sQuote{labels}.
For each located parameter, the label, model, matrix, row, col, value,
and lbound & ubound are given as a row in the dataframe.
Duplicated labels return a row for each location in which they are found.
}
\usage{
omxLocateParameters(model, labels = NULL, indep = FALSE, free = c(TRUE, FALSE, NA))
}
\arguments{
\item{model}{a MxModel object}
\item{labels}{optionally specify which free parameters to retrieve.}
\item{indep}{fetch parameters from independent submodels.}
\item{free}{fetch either free parameters (TRUE), or fixed parameters or both types. Default value is TRUE.}
}
\details{
Invoking the function with the default value for the \sQuote{labels}
argument retrieves all the free parameters. The \sQuote{labels}
argument can be used to select a subset of the free parameters.
Note that \sQuote{NA} is a valid input to \sQuote{labels}.
}
\seealso{
\code{\link{omxGetParameters}}, \code{\link{omxSetParameters}}, \code{\link{omxAssignFirstParameters}}
}
\examples{
A <- mxMatrix('Full', 2, 2, labels = c("A11", "A12", NA, "A11"), values= 1:4,
free = TRUE, byrow = TRUE, name = 'A')
model <- mxModel(A, name = 'model')
# Request all free parameters in model
omxLocateParameters(model)
# Request free parameters "A11" and all NAs
omxLocateParameters(model, c("A11", NA))
# Works with submodel
B = mxMatrix(name = 'B', 'Full', 1, 2, labels = c("B11", "notme"),
free = c(TRUE, FALSE), values= pi)
model <- mxModel(model, mxModel(B, name = 'subB'))
# nb: only returns free parameters ('notme' not shown)
omxLocateParameters(model)
}
|
