Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/qa/quantile.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

2.0 KiB
Vendored

title, description
title description
quantile OpenBB SDK Function

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

quantile

Overlay Median & Quantile

Source Code: [link]

openbb.qa.quantile(data: pd.DataFrame, window: int = 14, quantile_pct: float = 0.5)

Parameters

Name Type Description Default Optional
data pd.DataFrame Dataframe of targeted data None False
window int Length of window 14 True
quantile_pct float Quantile to display 0.5 True

Returns

Type Description
Tuple[pd.DataFrame, pd.DataFrame] Dataframe of rolling median prices over window,
Dataframe of rolling quantile prices over window

Plots rolling quantile

Source Code: [link]

openbb.qa.quantile_chart(data: pd.DataFrame, target: str, symbol: str = "", window: int = 14, quantile: float = 0.5, 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
quantile float Quantile to get 0.5 True
export str Format to export data True
external_axes Optional[List[plt.Axes]] External axes (1 axis is expected in the list), by default None None True

Returns

This function does not return anything