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/coint.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

2.0 KiB
Vendored
Raw Blame History

title, description
title description
coint OpenBB SDK Function

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

coint

Calculate cointegration tests between variable number of input series

Source Code: [link]

openbb.econometrics.coint(datasets: pd.Series, return_z: bool = False)

Parameters

Name Type Description Default Optional
datasets pd.Series Input series to test cointegration for None False
return_z bool Flag to return the z data to plot False True

Returns

Type Description
Union[pd.DataFrame,Dict] Dataframe with results of cointegration tests or a Dict of the z results

Estimates long-run and short-run cointegration relationship for series y and x and apply

Source Code: [link]

openbb.econometrics.coint_chart(datasets: pd.Series, significant: bool = False, plot: bool = True, export: str = "", external_axes: Optional[List[axes]] = None)

Parameters

Name Type Description Default Optional
datasets pd.Series Variable number of series to test for cointegration None False
significant float Show only companies that have p-values lower than this percentage False True
plot bool Whether you wish to plot the z-values of all pairs. True True
export str Format to export data True
external_axes Optional[List[plt.axes]] External axes to plot on None True

Returns

This function does not return anything