Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/econometrics/fe.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470)
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

1.1 KiB
Vendored

title, description
title description
fe OpenBB SDK Function

fe

When effects are correlated with the regressors the RE and BE estimators are not consistent.

Source Code: [link]

openbb.econometrics.fe(Y: pd.DataFrame, X: pd.DataFrame, entity_effects: bool = False, time_effects: bool = False)

Parameters

Name Type Description Default Optional
regression_variables list The regressions variables entered where the first variable is
the dependent variable.
None True
data dict A dictionary containing the datasets. None True
entity_effects bool Whether to include entity effects False True
time_effects bool Whether to include time effects False True

Returns

Type Description
Tuple[DataFrame, Any, List[Any], Any] The dataset used,
Dependent variable,
Independent variable,
PanelOLS model with Fixed Effects