mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-02 23:41:27 +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>
88 lines
2.4 KiB
Markdown
Vendored
88 lines
2.4 KiB
Markdown
Vendored
---
|
|
title: root
|
|
description: Detailed explanation of OpenBB's econometrics Python library focusing
|
|
on the functionality of unit root tests including ADF and KPSS tests. The page features
|
|
instructions on how to conduct these tests with Python, making it beneficial for
|
|
data analysts and those interested in data series analysis.
|
|
keywords:
|
|
- Docusaurus
|
|
- Econometrics
|
|
- ADF test
|
|
- KPSS test
|
|
- Data series
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="econometrics.root - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Calculate test statistics for unit roots
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/econometrics_model.py#L168)]
|
|
|
|
```python
|
|
openbb.econometrics.root(data: pd.Series, fuller_reg: str = "c", kpss_reg: str = "c")
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| data | pd.Series | Series or column of DataFrame of target variable | None | False |
|
|
| fuller_reg | str | Type of regression of ADF test | c | True |
|
|
| kpss_reg | str | Type of regression for KPSS test | c | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| pd.DataFrame | Dataframe with results of ADF test and KPSS test |
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Determine the normality of a timeseries.
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/econometrics_view.py#L197)]
|
|
|
|
```python
|
|
openbb.econometrics.root_chart(data: pd.Series, dataset: str = "", column: str = "", fuller_reg: str = "c", kpss_reg: str = "c", export: str = "")
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| data | pd.Series | Series of target variable | None | False |
|
|
| dataset | str | Name of the dataset | | True |
|
|
| column | str | Name of the column | | True |
|
|
| fuller_reg | str | Type of regression of ADF test. Choose c, ct, ctt, or nc | c | True |
|
|
| kpss_reg | str | Type of regression for KPSS test. Choose c or ct | c | True |
|
|
| export | str | Format to export data. | | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|