Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/qa/rolling.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.8 KiB
Vendored

title, description
title description
rolling OpenBB SDK Function

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

rolling

Return rolling mean and standard deviation

Source Code: [link]

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

Parameters

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

Returns

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

Plots mean std deviation

Source Code: [link]

openbb.qa.rolling_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
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 (2 axes are expected in the list), by default None None True

Returns

This function does not return anything