jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 21:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
7c193656a108eef2e8fda22bd7fca24a30aa9c39
OpenBB/website/content/sdk/reference/qa/spread.md
jose-donato 2e7eb4c9b6 New documentation website (#3526) 
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

1.9 KiB
Vendored
Raw Blame History

title, description
title description
spread OpenBB SDK Function

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

spread

Standard Deviation and Variance

Source Code: [link]

openbb.qa.spread(data: pd.DataFrame, window: int = 14)

Parameters

Name Type Description Default Optional
data pd.DataFrame DataFrame of targeted data None False
window int Length of window 14 True

Returns

Type Description
Tuple[pd.DataFrame, pd.DataFrame] Dataframe of rolling standard deviation,
Dataframe of rolling variance

Plots rolling spread

Source Code: [link]

openbb.qa.spread_chart(data: pd.DataFrame, target: str, symbol: str = "", window: int = 14, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
data pd.DataFrame Dataframe None False
target str Column in data to look at None False
target str Column in data to look at None False
symbol str Stock ticker True
window int Length of window 14 True
export str Format to export data True
external_axes Optional[List[plt.Axes]] External axes (3 axes are expected in the list), by default None None True

Returns

This function does not return anything