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

1.6 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
season The page provides details on the 'openbb.forecast.season_chart' function. This function is used to plot seasonality from a dataset. It includes information about the parameters, the return value, and a link to the source code.
openbb.forecast.season_chart
season chart
plot seasonality
dataset
dataframe
time lag
max lag
confidence interval

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

Plot seasonality from a dataset

Source Code: [link]

openbb.forecast.season_chart(data: pd.DataFrame, column: str = "close", export: str = "", m: Optional[int] = None, max_lag: int = 24, alpha: float = 0.05, external_axes: Optional[List[axes]] = None)

Parameters

Name Type Description Default Optional
data pd.DataFrame The dataframe to plot None False
column str The column of the dataframe to analyze close True
export str Format to export image True
m Optional[int] Optionally, a time lag to highlight on the plot. Default is none. None True
max_lag int The maximal lag order to consider. Default is 24. 24 True
alpha float The confidence interval to display. Default is 0.05. 0.05 True
external_axes Optional[List[plt.axes]] External axes to plot on None True

Returns

This function does not return anything