mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 21:42:22 +00:00
2e7eb4c9b6
* fix(docs): added margin between sections * feat: removed unused files; updated ga * fix: juan stuff doesnt work * fix: random fix * moon at noon * fix: update docusaurus config * Update controller_doc_classes.py * fix: temp fix * fix: temp fix * Update controller_doc_classes.py * fix: remove old content * fix: taggfix * init * fix: styling and moved file * Update generate_terminal_markdown.py * fix: removed unused images * fix: port new files * Update generate_sdk_markdown.py * Update controller_doc_classes.py Co-authored-by: teh_coderer <me@tehcoderer.com>
79 lines
2.0 KiB
Markdown
Vendored
79 lines
2.0 KiB
Markdown
Vendored
---
|
||
title: unitroot
|
||
description: OpenBB SDK Function
|
||
---
|
||
|
||
import Tabs from '@theme/Tabs';
|
||
import TabItem from '@theme/TabItem';
|
||
|
||
# unitroot
|
||
|
||
<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/common/quantitative_analysis/qa_model.py#L135)]
|
||
|
||
```python
|
||
openbb.qa.unitroot(data: pd.DataFrame, fuller_reg: str = "c", kpss_reg: str = "c")
|
||
```
|
||
|
||
---
|
||
|
||
## Parameters
|
||
|
||
| Name | Type | Description | Default | Optional |
|
||
| ---- | ---- | ----------- | ------- | -------- |
|
||
| data | pd.DataFrame | DataFrame of target variable | None | False |
|
||
| fuller_reg | str | Type of regression of ADF test. Can be ‘c’,’ct’,’ctt’,’nc’ 'c' - Constant and t - trend order | c | True |
|
||
| kpss_reg | str | Type of regression for KPSS test. Can be ‘c’,’ct' | c | True |
|
||
|
||
|
||
---
|
||
|
||
## Returns
|
||
|
||
| Type | Description |
|
||
| ---- | ----------- |
|
||
| pd.DataFrame | Dataframe with results of ADF test and KPSS test |
|
||
---
|
||
|
||
|
||
|
||
</TabItem>
|
||
<TabItem value="view" label="Chart">
|
||
|
||
Prints table showing unit root test calculations
|
||
|
||
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_view.py#L839)]
|
||
|
||
```python
|
||
openbb.qa.unitroot_chart(data: pd.DataFrame, target: str, fuller_reg: str = "c", kpss_reg: str = "c", export: str = "")
|
||
```
|
||
|
||
---
|
||
|
||
## Parameters
|
||
|
||
| Name | Type | Description | Default | Optional |
|
||
| ---- | ---- | ----------- | ------- | -------- |
|
||
| data | pd.DataFrame | DataFrame | None | False |
|
||
| target | str | Column of data to look at | None | False |
|
||
| fuller_reg | str | Type of regression of ADF test. Can be ‘c’,’ct’,’ctt’,’nc’ 'c' - Constant and t - trend order | c | True |
|
||
| kpss_reg | str | Type of regression for KPSS test. Can be ‘c’,’ct' | c | True |
|
||
| export | str | Format for exporting data | | True |
|
||
|
||
|
||
---
|
||
|
||
## Returns
|
||
|
||
This function does not return anything
|
||
|
||
---
|
||
|
||
|
||
|
||
</TabItem>
|
||
</Tabs> |