mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 07:51:49 +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>
57 lines
1.5 KiB
Markdown
Vendored
57 lines
1.5 KiB
Markdown
Vendored
---
|
|
title: cusum
|
|
description: Documentation page for the Cumulative Sum Algorithm (CUSUM) used in the
|
|
OpenBB Terminal for quantitative analysis. Contains a snippet of the source code,
|
|
parameters descriptions, and an example of usage.
|
|
keywords:
|
|
- OpenBB Terminal documentation
|
|
- Cumulative Sum Algorithm
|
|
- CUSUM
|
|
- quantitative analysis
|
|
- parameters description
|
|
- OpenBB SDK
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="qa.cusum - Reference | OpenBB SDK Docs" />
|
|
|
|
Plots Cumulative sum algorithm (CUSUM) to detect abrupt changes in data
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_view.py#L523)]
|
|
|
|
```python
|
|
openbb.qa.cusum(data: pd.DataFrame, target: str, threshold: float = 5, drift: float = 2.1, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| data | pd.DataFrame | Dataframe | None | False |
|
|
| target | str | Column of data to look at | None | False |
|
|
| threshold | float | Threshold value | 5 | True |
|
|
| drift | float | Drift parameter | 2.1 | True |
|
|
| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
from openbb_terminal.sdk import openbb
|
|
df = openbb.stocks.load("AAPL")
|
|
openbb.qa.cusum(data=df, target="Adj Close")
|
|
```
|
|
|
|
---
|