mbcmodel.linearmodelparameters

Properties for linearmodelparameters model objects

expand all in page

    Description

    Use these properties to create and examine linearmodelparameters model objects.

    Creation

    Syntax

    LinModelParamObj = ModelObj.Parameters

    Description

    LinModelParamObj = ModelObj.Parameters creates an mbcmodel.linearmodelparameters object for the linear mbcmodel.model object ModelObj.

    Properties

    expand all

    This property is read-only.

    Number of model parameters, specified as a scalar.

    To see the total possible number of parameters in a linear model, use SizeOfParameterSet.

    Data Types: double

    This property is read-only.

    Parameter object names, specified as a cell array of character vectors.

    Data Types: char | string

    This property is read-only.

    Parameter object values, specified as an array.

    This property is read-only.

    Stepwise status of model parameters, specified as a cell array of character vectors. The stepwise status for each term is Always, Never, or Step. The status determines whether you can use the StepwiseRegression function to throw away terms to improve the predictive power of the model.

    • Always – Always included in the model.

    • Never – Never included in the model.

    • Step – Choose whether to include or exclude this term. Do this by using StepwiseRegression to toggle between in and out for particular parameters.

    Data Types: char | string

    This property is read-only.

    Size of parameter set, specified as a scalar. Not all of these terms are necessarily currently included in the model. You can use StepwiseRegression to remove terms.

    Data Types: double

    This property is read-only.

    Model parameters currently included and excluded, specified as a cell array of character vectors. This property provides a status for each parameter in the model, in or out, depending on whether the term is included or excluded.

    You can remove or include parameters using StepwiseRegression, as long a StepwiseStatus is Step. Call StepwiseRegression on the parent model object to toggle between in and out for particular parameters. You must call UpdateResponse before calling StepwiseSelection.

    Data Types: char | string

    Examples

    collapse all

    1. Obtain the StepwiseStatus property of the mbcmodel.linearmodelparameter object LinModelParamObj.

      N = LinModelParamObj.StepwiseStatus

    2. Obtain the NumParameters property of the mbcmodel.linearmodelparameter object LinModelParamObj

      N = LinModelParamObj.NumParameters;

    Version History

    Introduced in R2006a

    See Also

    |