OpenBB/website/content/common/quantitative_analysis/unitroot/_index.md

usage: unitroot [-r {c,ct,ctt,nc}] [-k {c,ct}] [--export {csv,json,xlsx}] [-h]

Unit root test / stationarity (ADF, KPSS)

In statistics, a unit root test tests whether a time series variable is non-stationary and possesses a unit root. The null hypothesis is generally defined as the presence of a unit root and the alternative hypothesis is either stationarity, trend stationarity or explosive root depending on the test used.

See the Wiki page on this subject for more information: https://en.wikipedia.org/wiki/Unit_root_test

optional arguments:
  -r {c,ct,ctt,nc}, --fuller_reg {c,ct,ctt,nc}
                        Type of regression. Can be ‘c’,’ct’,’ctt’,’nc’ 'c' - Constant and t - trend order (default: c)
  -k {c,ct}, --kps_reg {c,ct}
                        Type of regression. Can be ‘c’,’ct' (default: c)
  --export {csv,json,xlsx}
                        Export dataframe data to csv,json,xlsx file (default: )
  -h, --help            show this help message (default: False)

Sample output:

(✨) (stocks)>(qa)> unitroot
╒════════════════╤═══════════╤═════════════════════╕
│                │       ADF │ KPSS                │
╞════════════════╪═══════════╪═════════════════════╡
│ Test Statistic │   -4.8135 │ 0.38852605166304083 │
├────────────────┼───────────┼─────────────────────┤
│ P-Value        │    0.0001 │ 0.08210083980041344 │
├────────────────┼───────────┼─────────────────────┤
│ NLags          │    9.0000 │ 7                   │
├────────────────┼───────────┼─────────────────────┤
│ Nobs           │  242.0000 │                     │
├────────────────┼───────────┼─────────────────────┤
│ ICBest         │ -188.0797 │                     │
╘════════════════╧═══════════╧═════════════════════╛