jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 13:01:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cffd302b0f028abda77d75983f775ace34fe3c19
OpenBB/website/content/sdk/reference/qa/decompose.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* 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>
2023-10-30 21:01:29 +00:00

1.4 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
decompose 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.
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';

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