Files
OpenBB/website/content/sdk/reference/econometrics/bgod.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.0 KiB
Vendored

title, description, keywords
title description keywords
bgod This page provides documentation for bgod and bgod_chart methods of OpenBB. The bgod method calculates test statistics for autocorrelation in an OLS model, and bgod_chart displays the Breusch-Godfrey autocorrelation test.
bgod
bgod_chart
autocorrelation
Breusch-Godfrey Test
OLS model
statistics
data analysis
econometrics

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

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

Calculate test statistics for autocorrelation

Source Code: [link]

openbb.econometrics.bgod(model: pd.DataFrame, lags: int = 3)

Parameters

Name Type Description Default Optional
model OLS Model OLS model that has been fit. None False
lags int The amount of lags. 3 True

Returns

Type Description
pd.DataFrame Test results from the Breusch-Godfrey Test

Show Breusch-Godfrey autocorrelation test

Source Code: [link]

openbb.econometrics.bgod_chart(model: statsmodels.regression.linear_model.RegressionResultsWrapper, lags: int = 3, export: str = "")

Parameters

Name Type Description Default Optional
model OLS Model OLS model that has been fit. None False
lags int The amount of lags included. 3 True
export str Format to export data True

Returns

This function does not return anything