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
65ecfd75aa7c1929368328f84de617873acbb917
OpenBB/website/versioned_docs/version-v3/sdk/reference/qa/spread.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

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