Get information about the parameter that is specified by an index number, based on an arbitrary ordering of model parameters. The first parameter is parameter number 1.
Syntax
object.ParameterInfo (parameterNumber, groupNumber, parameterType, leftVariable, rightVariable)
The ParameterInfo method syntax has the following parts:
Part |
Description |
object |
An object of type AmosEngine. |
parameterNumber |
Input: A whole number between 1 and n, where n is the number of parameters. |
groupNumber |
Output: When the parameter specified by parameterNumber is associated with one group only, then groupNumber is that group's number. The first group is group number 1. |
parameterType |
Output: An integer that tells what kind of parameter is specified by parameterNumber. The possible values are 1 (regression weight), 2 (mean), 3 (intercept), 4 (covariance) and 5 (variance). |
leftVariable, rightVariable |
Integers that specify two variables. (Use the VariableName method to get their names.) If the parameter specified by parameterNumber is a regression weight, leftVariable refers to the dependent variable, rightVariable to the independent variable. If the parameter specified by parameterNumber is a covariance, it is the covariance between leftVariable and rightVariable. If the parameter specified by parameterNumber is a variance, it is the variance of leftVariable. (rightVariable is the same as leftVariable.) If the parameter specified by parameterNumber is a mean, it is the mean of leftVariable. (The value returned for rightVariable is undefined.) |
Placement: [3].
See Also