jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-05 08:51:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4e6a2fb5648d7e8ee4fdb31d1ce6ffddbaf701bf
OpenBB/website/content/api/common/qa/decompose/_index.md
Colin Delahunty 0b33cb45f8 Adds auto yaml generation (#2587) 
* Began working on docs creator

* Added fixes

* More

* More

* Adding autogen_try.py for OpenBB API doc generation

* OpenBB API docs gen try

* Fixed

* Added fixes

* Added fixes

* subs -> sub

* Updated docs

* Updated docs

Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
2022-09-23 16:43:34 +01:00

580 B
Vendored
Raw Blame History

Get underlying data

common.qa.decompose(data: pandas.core.frame.DataFrame, multiplicative: bool = False) -> Tuple[Any, pandas.core.frame.DataFrame, pandas.core.frame.DataFrame]

Perform seasonal decomposition

Parameters
----------
data : pd.DataFrame
    Dataframe of targeted data
multiplicative : bool
    Boolean to indicate multiplication instead of addition

Returns
-------
result: Any
    Result of statsmodels seasonal_decompose
cycle: pd.DataFrame
    Filtered cycle
trend: pd.DataFrame
    Filtered Trend