jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-07 09:52:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4e6a2fb5648d7e8ee4fdb31d1ce6ffddbaf701bf
OpenBB/website/content/api/econometrics/get_regression_data/_index.md
Colin Delahunty 0b33cb45f8 Adds auto yaml generation (#2587) 
* Began working on docs creator

* Added fixes

* More

* More

* Adding autogen_try.py for OpenBB API doc generation

* OpenBB API docs gen try

* Fixed

* Added fixes

* Added fixes

* subs -> sub

* Updated docs

* Updated docs

Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
2022-09-23 16:43:34 +01:00

773 B
Vendored
Raw Blame History

Get underlying data

econometrics.get_regression_data(regression_variables: List[tuple], data: Dict[str, pandas.core.frame.DataFrame], regression_type: str = '') -> Tuple[pandas.core.frame.DataFrame, Any, List[Any]]

This function creates a DataFrame with the required regression data as well sets up the dependent and independent variables.

Parameters
----------
regression_variables : list
    The regressions variables entered where the first variable is
    the dependent variable.
data : dict
    A dictionary containing the datasets.
regression_type: str
    The type of regression that is executed.

Returns
-------
The dataset used, the dependent variable, the independent variable and
the OLS model.