mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 16:02:04 +00:00
4ad995fdd0
* 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>
51 lines
1.6 KiB
Markdown
Vendored
51 lines
1.6 KiB
Markdown
Vendored
---
|
|
title: season
|
|
description: 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.
|
|
keywords:
|
|
- 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';
|
|
|
|
<HeadTitle title="forecast.season - Reference | OpenBB SDK Docs" />
|
|
|
|
Plot seasonality from a dataset
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_view.py#L120)]
|
|
|
|
```python
|
|
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
|
|
|
|
---
|