statsmodels.genmod.cov_struct.CovStruct

class statsmodels.genmod.cov_struct.CovStruct(cov_nearest_method='clipped')

Base class for correlation and covariance structures.

An implementation of this class takes the residuals from a regression model that has been fit to grouped data, and uses them to estimate the within-group dependence structure of the random errors in the model.

The current state of the covariance structure is represented through the value of the dep_params attribute.

The default state of a newly-created instance should always be the identity correlation matrix.

Methods

covariance_matrix(endog_expval, index)	Returns the working covariance or correlation matrix for a given cluster of data.
covariance_matrix_solve(expval, index, …)	Solves matrix equations of the form covmat * soln = rhs and returns the values of soln, where covmat is the covariance matrix represented by this class.
initialize(model)	Called by GEE, used by implementations that need additional setup prior to running fit.
summary()	Returns a text summary of the current estimate of the dependence structure.
update(params)	Update the association parameter values based on the current regression coefficients.

Methods

covariance_matrix(endog_expval, index)	Returns the working covariance or correlation matrix for a given cluster of data.
covariance_matrix_solve(expval, index, …)	Solves matrix equations of the form covmat * soln = rhs and returns the values of soln, where covmat is the covariance matrix represented by this class.
initialize(model)	Called by GEE, used by implementations that need additional setup prior to running fit.
summary()	Returns a text summary of the current estimate of the dependence structure.
update(params)	Update the association parameter values based on the current regression coefficients.