mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 07:51:49 +00:00
4ad995fdd0
* 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>
97 lines
3.5 KiB
Markdown
Vendored
97 lines
3.5 KiB
Markdown
Vendored
---
|
|
title: ols
|
|
description: Perform OLS regression on timeseries data using the 'ols' function from
|
|
OpenBB's econometrics module. The page includes parameters description, return type,
|
|
and a practical example with code.
|
|
keywords:
|
|
- ols
|
|
- timeseries data
|
|
- statsmodels
|
|
- regression
|
|
- openbb.econometrics.ols
|
|
- Dependent variable series
|
|
- Independent variables series
|
|
- RegressionResultsWrapper
|
|
- OLS Regression Results
|
|
- R-squared
|
|
- Least Squares
|
|
- F-statistic
|
|
- Prob (F-statistic)
|
|
- Log-Likelihood
|
|
- AIC
|
|
- BIC
|
|
- Df Residuals
|
|
- Df Model
|
|
- Covariance Type
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="econometrics.ols - Reference | OpenBB SDK Docs" />
|
|
|
|
Performs an OLS regression on timeseries data. [Source: Statsmodels]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/regression_model.py#L176)]
|
|
|
|
```python
|
|
openbb.econometrics.ols(Y: pd.DataFrame, X: pd.DataFrame)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| Y | pd.DataFrame | Dependent variable series. | None | False |
|
|
| X | pd.DataFrame | Dataframe of independent variables series. | None | False |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| statsmodels.regression.linear_model.RegressionResultsWrapper | Regression model wrapper from statsmodels. |
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
import openbb_terminal.sdk as openbb
|
|
df = openbb.econometrics.load("wage_panel")
|
|
OLS_model = openbb.econometrics.OLS(df["lwage"], df[["educ", "exper", "expersq"]])
|
|
print(OLS_model.summary())`
|
|
```
|
|
|
|
```
|
|
OLS Regression Results
|
|
=======================================================================================
|
|
Dep. Variable: lwage R-squared (uncentered): 0.920
|
|
Model: OLS Adj. R-squared (uncentered): 0.919
|
|
Method: Least Squares F-statistic: 1.659e+04
|
|
Date: Thu, 10 Nov 2022 Prob (F-statistic): 0.00
|
|
Time: 15:28:11 Log-Likelihood: -3091.3
|
|
No. Observations: 4360 AIC: 6189.
|
|
Df Residuals: 4357 BIC: 6208.
|
|
Df Model: 3
|
|
Covariance Type: nonrobust
|
|
==============================================================================
|
|
coef std err t P>|t| [0.025 0.975]
|
|
------------------------------------------------------------------------------
|
|
educ 0.0986 0.002 39.879 0.000 0.094 0.103
|
|
exper 0.1018 0.009 10.737 0.000 0.083 0.120
|
|
expersq -0.0034 0.001 -4.894 0.000 -0.005 -0.002
|
|
==============================================================================
|
|
Omnibus: 1249.642 Durbin-Watson: 0.954
|
|
Prob(Omnibus): 0.000 Jarque-Bera (JB): 9627.436
|
|
Skew: -1.152 Prob(JB): 0.00
|
|
Kurtosis: 9.905 Cond. No. 86.4
|
|
==============================================================================
|
|
Notes:
|
|
[1] R² is computed without centering (uncentered) since the model does not contain a constant.
|
|
[2] Standard Errors assume that the covariance matrix of the errors is correctly specified.
|
|
```
|
|
---
|