jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 07:51:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/econometrics/granger.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

2.4 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
granger Documentation about Granger test functions to calculate and visualize Econometrics models in OpenBB terminal. Covers usage, parameters and return types.
Granger test
Econometrics
OpenBB terminal
Source code
Function parameters
function return

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

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

Calculate granger tests

Source Code: [link]

openbb.econometrics.granger(dependent_series: pd.Series, independent_series: pd.Series, lags: int = 3)

Parameters

Name Type Description Default Optional
dependent_series Series The series you want to test Granger Causality for. None False
independent_series Series The series that you want to test whether it Granger-causes time_series_y None False
lags int The amount of lags for the Granger test. By default, this is set to 3. 3 True

Returns

Type Description
dict Dictionary containing results of Granger test

Show granger tests

Source Code: [link]

openbb.econometrics.granger_chart(dependent_series: pd.Series, independent_series: pd.Series, lags: int = 3, confidence_level: float = 0.05, export: str = "")

Parameters

Name Type Description Default Optional
dependent_series Series The series you want to test Granger Causality for. None False
independent_series Series The series that you want to test whether it Granger-causes dependent_series None False
lags int The amount of lags for the Granger test. By default, this is set to 3. 3 True
confidence_level float The confidence level you wish to use. By default, this is set to 0.05. 0.05 True
export str Format to export data True

Returns

This function does not return anything