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
e0be8cdacfdd2e95b58ee545bfcf258ddff6750c
OpenBB/website/content/sdk/reference/qa/quantile.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* 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>
2023-10-30 21:01:29 +00:00

2.4 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
quantile This page provides documentation and source code for OpenBB's Quantile function. It includes info about parameters, return types, and how to generate and plot rolling quantile data using Python.
Docusaurus
Quantile
Source Code
Quantitative Analysis
Plotting Data
Rolling Quantile
Python DataFrame

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

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

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