linearmodels.panel.model.BetweenOLS

class linearmodels.panel.model.BetweenOLS(dependent: PanelData | ndarray | DataArray | DataFrame | Series, exog: PanelData | ndarray | DataArray | DataFrame | Series, *, weights: PanelData | ndarray | DataArray | DataFrame | Series | None = None, check_rank: bool = True)[source]

Between estimator for panel data

Parameters:
dependent: PanelData | ndarray | DataArray | DataFrame | Series

Dependent (left-hand-side) variable (time by entity)

exog: PanelData | ndarray | DataArray | DataFrame | Series

Exogenous or right-hand-side variables (variable by time by entity).

weights: PanelData | ndarray | DataArray | DataFrame | Series | None = None

Weights to use in estimation. Assumes residual variance is proportional to inverse of weight to that the residual time the weight should be homoskedastic.

Notes

The model is given by

\[\bar{y}_{i}= \beta^{\prime}\bar{x}_{i}+\bar{\epsilon}_{i}\]

where \(\bar{z}\) is the time-average.

Methods

fit(*[, reweight, cov_type, debiased])

Estimate model parameters

from_formula(formula, data, *[, weights, ...])

Create a model from a formula

predict(params, *[, exog, data, eval_env, ...])

Predict values for additional data

reformat_clusters(clusters)

Reformat cluster variables

Properties

formula

Formula used to construct the model

has_constant

Flag indicating the model a constant or implicit constant

not_null

Locations of non-missing observations