mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 05:21:48 +00:00
79046608b6
* Update generate_terminal_markdown.py * updates * update workflows * Automated Change * tests * tests * Automated Change * Update test_generate_docs.py * Automated Change * updates * Automated Change * Update gen-docs.yml * Update test.yml * Automated Change * Update test.yml * Automated Change * Update generate_sdk_markdown.py * Automated Change * test * Automated Change * testtt23 * Automated Change * Update generate_sdk_markdown.py * Automated Change * Automated Change * added empting reference folders before autogen docs * updates * Automated Change * update tests gitactions * Automated Change * up * Automated Change * Automated Change * update pytest * Automated Change * tests * Automated Change * examples update * Automated Change * Update generate_sdk_markdown.py * Automated Change * Update test.yml * Update generate_sdk_markdown.py * strip * Automated Change * Workflow : check test update * Automated Change * Automated Change * Automated Change * Update test.yml * Automated Change * Update test.yml * Automated Change * Automated Change * up * Automated Change * Update generate_sdk_markdown.py * Automated Change * update workflows * fix guides * testing * Update gh-pages.yml * Update gh-pages.yml Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com> Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com> Co-authored-by: Chavithra PARANA <chavithra@gmail.com> Co-authored-by: Chavithra <Chavithra@users.noreply.github.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
52 lines
1.9 KiB
Markdown
Vendored
52 lines
1.9 KiB
Markdown
Vendored
---
|
|
title: root
|
|
description: OpenBB Terminal Function
|
|
---
|
|
|
|
# root
|
|
|
|
Show unit root tests of a column of a dataset
|
|
|
|
### Usage
|
|
|
|
```python
|
|
root -v {} [-r {c,ct,ctt,n}] [-k {c,ct}]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Default | Optional | Choices |
|
|
| ---- | ----------- | ------- | -------- | ------- |
|
|
| column | The column and name of the database you want test unit root for | None | False | None |
|
|
| fuller_reg | Type of regression. Can be 'c','ct','ctt','nc'. c - Constant and t - trend order | c | True | c, ct, ctt, n |
|
|
| kpss_reg | Type of regression. Can be 'c', 'ct'. c - Constant and t - trend order | c | True | c, ct |
|
|
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
2022 Jun 01, 06:47 (🦋) /econometrics/ $ load fair
|
|
|
|
2022 Jun 01, 06:47 (🦋) /econometrics/ $ root fair.yrs_married
|
|
|
|
Unitroot from dataset 'fair of 'yrs_married'
|
|
┏━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┓
|
|
┃ ┃ ADF ┃ KPSS ┃
|
|
┡━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━┩
|
|
│ Test Statistic │ -8.08 │ 7.01 │
|
|
├────────────────┼──────────┼───────┤
|
|
│ P-Value │ 0.00 │ 0.01 │
|
|
├────────────────┼──────────┼───────┤
|
|
│ NLags │ 34.00 │ 26.00 │
|
|
├────────────────┼──────────┼───────┤
|
|
│ Nobs │ 6331.00 │ 0.00 │
|
|
├────────────────┼──────────┼───────┤
|
|
│ ICBest │ 42958.72 │ 0.00 │
|
|
└────────────────┴──────────┴───────┘
|
|
```
|
|
---
|