mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-04 00:12:29 +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>
53 lines
1.2 KiB
Markdown
Vendored
53 lines
1.2 KiB
Markdown
Vendored
---
|
|
title: season
|
|
description: Meta description for the 'season' function in Docusaurus. This function
|
|
helps to display and understand the seasonality for a given column in a dataset,
|
|
providing options for customization such as time lag, maximal lag order, and confidence
|
|
interval.
|
|
keywords:
|
|
- docusaurus
|
|
- season
|
|
- dataset
|
|
- seasonality
|
|
- time lag
|
|
- maximal lag order
|
|
- confidence interval
|
|
- data visualization
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="forecast /season - Reference | OpenBB Terminal Docs" />
|
|
|
|
The seasonality for a given column
|
|
|
|
### Usage
|
|
|
|
```python
|
|
season [-v {}] [-m M] [--max_lag MAX_LAG] [-a ALPHA]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Default | Optional | Choices |
|
|
| ---- | ----------- | ------- | -------- | ------- |
|
|
| values | Dataset.column values to be displayed in a plot | None | True | None |
|
|
| m | A time lag to highlight on the plot | None | True | None |
|
|
| max_lag | The maximal lag order to consider | 24 | True | None |
|
|
| alpha | The confidence interval to display | 0.05 | True | None |
|
|
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
(🦋) /forecast/ $ load TSLA.csv
|
|
|
|
(🦋) /forecast/ $ season TSLA.volume
|
|
TODO: screen shot
|
|
```
|
|
---
|