mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-02 23:41:27 +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>
54 lines
1.4 KiB
Markdown
Vendored
54 lines
1.4 KiB
Markdown
Vendored
---
|
|
title: decompose
|
|
description: This documentation page provides details on the 'decompose' function
|
|
in OpenBB's quantitative analysis module. The function executes seasonal decomposition
|
|
on a specified DataFrame, returning decomposed results and filtered dataframes for
|
|
cycle and trend.
|
|
keywords:
|
|
- decompose
|
|
- seasonal decomposition
|
|
- quantitative analysis
|
|
- multiplicative
|
|
- dataframe
|
|
- DecomposeResult
|
|
- statsmodels
|
|
- observed
|
|
- seasonal
|
|
- trend
|
|
- residual
|
|
- weights
|
|
- cycle DataFrame
|
|
- trend DataFrame
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="qa.decompose - Reference | OpenBB SDK Docs" />
|
|
|
|
Perform seasonal decomposition
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_model.py#L46)]
|
|
|
|
```python
|
|
openbb.qa.decompose(data: pd.DataFrame, multiplicative: bool = False)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| data | pd.DataFrame | Dataframe of targeted data | None | False |
|
|
| multiplicative | bool | Boolean to indicate multiplication instead of addition | False | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| Tuple[DecomposeResult, pd.DataFrame, pd.DataFrame] | DecomposeResult class from statsmodels (observed, seasonal, trend, residual, and weights),<br/>Filtered cycle DataFrame,<br/>Filtered trend DataFrame |
|
|
---
|