jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-06 09:22:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
aafb5a52ff1b71fa82f8a175b76b0bba1bf66c21
OpenBB/website/content/api/econometrics/root/_index.md
Colin Delahunty 0b33cb45f8 Adds auto yaml generation (#2587) 
* Began working on docs creator

* Added fixes

* More

* More

* Adding autogen_try.py for OpenBB API doc generation

* OpenBB API docs gen try

* Fixed

* Added fixes

* Added fixes

* subs -> sub

* Updated docs

* Updated docs

Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
2022-09-23 16:43:34 +01:00

1.2 KiB
Vendored
Raw Blame History

To obtain charts, make sure to add chart=True as the last parameter

Get underlying data

econometrics.root(data: pandas.core.series.Series, fuller_reg: str = 'c', kpss_reg: str = 'c') -> pandas.core.frame.DataFrame

Calculate test statistics for unit roots

Parameters
----------
data : pd.Series
    Series or column of DataFrame of target variable
fuller_reg : str
    Type of regression of ADF test
kpss_reg : str
    Type of regression for KPSS test

Returns
-------
pd.DataFrame
    Dataframe with results of ADF test and KPSS test

Getting charts

econometrics.root(data: pandas.core.series.Series, dataset: str = '', column: str = '', fuller_reg: str = 'c', kpss_reg: str = 'c', export: str = '', chart=True)

Determine the normality of a timeseries.

Parameters
----------
data : pd.Series
    Series of target variable
dataset: str
    Name of the dataset
column: str
    Name of the column
fuller_reg : str
    Type of regression of ADF test. Choose c, ct, ctt, or nc
kpss_reg : str
    Type of regression for KPSS test. Choose c or ct
export: str
    Format to export data.