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>
44 lines
1.3 KiB
Markdown
Vendored
44 lines
1.3 KiB
Markdown
Vendored
---
|
|
title: bols
|
|
description: The page provides detailed instructions on how to use the 'Between estimator',
|
|
which is part of the openbb.econometrics.bols Python function. It covers parameters,
|
|
return values, and the code to be used.
|
|
keywords:
|
|
- Between estimator
|
|
- OLS model
|
|
- Dependent variable
|
|
- Independent variable
|
|
- openbb.econometrics.bols
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="econometrics.bols - Reference | OpenBB SDK Docs" />
|
|
|
|
The between estimator is an alternative, usually less efficient estimator, can can be used to
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/regression_model.py#L314)]
|
|
|
|
```python
|
|
openbb.econometrics.bols(Y: pd.DataFrame, X: pd.DataFrame)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| regression_variables | list | The regressions variables entered where the first variable is<br/>the dependent variable. | None | True |
|
|
| data | dict | A dictionary containing the datasets. | None | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| Tuple[DataFrame, Any, List[Any], Any] | The dataset used,<br/>Dependent variable,<br/>Independent variable,<br/>Between OLS model. |
|
|
---
|