Files
OpenBB/website/content/sdk/reference/econometrics/get_regression_data.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622)
* add first iteration of content for Terminal Pro

* Update index.md

* Update dashboards.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update quick-start.md

* Update index.md

* Update index.md

* Update home.md

* Update news.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update data-manipulation.md

* Update forecasting.md

* fix: images self closing tags

* fix: only pro visitors can see pro

* inter font

* improve SEO content and restructuring

* add new package for toggle on tutorials

* move folder around

* improve main page of each prod

* small updates and improvements

* fix logo above

* small improvement in headtitle for portfolio funcs

* fix typos from OpenAI's GPT-4

* fix _category_ json

* remove generic SEO words

* add script that generates SEO for documentation

* add missing file

* remove sdk warning message

* fix links for andrew

---------

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-10-30 21:01:29 +00:00

1.6 KiB
Vendored

title, description, keywords
title description keywords
get_regression_data The 'get_regression_data' page offers a detailed overview of OpenBB finance's function for regression data creation. It provides the source code link, describes the parameters like regression variables and type, and explains the returned results, such as the used dataset, dependent and independent variables, and the OLS model.
get_regression_data
OpenBB finance
regression variables
source code link
regression type
OLS model
dependent variable
independent variable
econometrics

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

This function creates a DataFrame with the required regression data as

Source Code: [link]

openbb.econometrics.get_regression_data(regression_variables: List[tuple], data: Dict[str, pd.DataFrame], regression_type: str = "")

Parameters

Name Type Description Default Optional
regression_variables list The regressions variables entered where the first variable is
the dependent variable.
None False
data dict A dictionary containing the datasets. None False
regression_type str The type of regression that is executed. True

Returns

Type Description
Tuple[DataFrame, Any, List[Any]] The dataset used,
Dependent variable,
Independent variable,
OLS model.