jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-29 13:32:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f68929fa1efaa5e9abb7911029e287c975b37fd3
OpenBB/website/content/sdk/reference/forecast/season.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

1.1 KiB
Vendored
Raw Blame History

title, description
title description
season OpenBB SDK Function

season

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