Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/qa/decompose.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470)
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

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