jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 13:01:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f68929fa1efaa5e9abb7911029e287c975b37fd3
OpenBB/website/content/sdk/reference/econometrics/root.md
jose-donato 2e7eb4c9b6 New documentation website (#3526) 
* 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>
2022-11-22 16:47:03 +00:00

1.9 KiB
Vendored
Raw Blame History

title, description
title description
root OpenBB SDK Function

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

root

Calculate test statistics for unit roots

Source Code: [link]

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

Determine the normality of a timeseries.

Source Code: [link]

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