Skip to main content

season

Plot seasonality from a dataset

Source Code: [link]

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

Parameters

NameTypeDescriptionDefaultOptional
datapd.DataFrameThe dataframe to plotNoneFalse
columnstrThe column of the dataframe to analyzecloseTrue
sheet_namestrOptionally specify the name of the sheet the data is exported to.NoneTrue
exportstrFormat to export imageTrue
mOptional[int]Optionally, a time lag to highlight on the plot. Default is none.NoneTrue
max_lagintThe maximal lag order to consider. Default is 24.24True
alphafloatThe confidence interval to display. Default is 0.05.0.05True
external_axesboolWhether to return the figure object or not, by default FalseFalseTrue

Returns

This function does not return anything