mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 13:01:38 +00:00
* Adding versioning to docs --------- Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: tehcoderer <me@tehcoderer.com>
898 B
Vendored
898 B
Vendored
title, description
| title | description |
|---|---|
| decompose | OpenBB SDK Function |
decompose
Perform seasonal decomposition
Source Code: [link]
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), Filtered cycle DataFrame, Filtered trend DataFrame |