Files
OpenBB/website/content/terminal/reference/crypto/qa/unitroot.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622)
* 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>
2023-10-30 21:01:29 +00:00

60 lines
2.1 KiB
Markdown
Vendored
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: unitroot
description: This page provides comprehensive instructions and usage examples for
the unitroot tool. Unitroot, used for unit root test and stationarity, offers multiple
regression methods including c, ct, ctt, and nc.
keywords:
- unitroot
- unit root test
- stationarity
- ADF
- KPSS
- regression
- programming
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="crypto/qa/unitroot - Reference | OpenBB Terminal Docs" />
Unit root test / stationarity (ADF, KPSS)
### Usage
```python
unitroot [-r {c,ct,ctt,nc}] [-k {c,ct}]
```
---
## Parameters
| Name | Description | Default | Optional | Choices |
| ---- | ----------- | ------- | -------- | ------- |
| fuller_reg | Type of regression. Can be ‘c’,’ct’,’ctt’,’nc’ 'c' - Constant and t - trend order | c | True | c, ct, ctt, nc |
| kpss_reg | Type of regression. Can be ‘c’,’ct' | c | True | c, ct |
---
## Examples
```python
2022 Feb 16, 11:16 (🦋) /stocks/qa/ $ unitroot
Unit Root Calculation
┏━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━┓
┃ ┃ ADF ┃ KPSS ┃
┡━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━┩
│ Test Statistic │ -28.9536 │ 0.2928 │
├────────────────┼────────────┼────────┤
│ P-Value │ 0.0000 │ 0.1000 │
├────────────────┼────────────┼────────┤
│ NLags │ 0.0000 │ 3 │
├────────────────┼────────────┼────────┤
│ Nobs │ 759.0000 │ │
├────────────────┼────────────┼────────┤
│ ICBest │ -3339.2013 │ │
└────────────────┴────────────┴────────┘
```
---