jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-12 20:31:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
8731fbd692f911e10778207df26276fcce715e21
OpenBB/website/content/api/common/qa/quantile/_index.md
Colin Delahunty 8731fbd692 Auto Generate API Documentation (#2360) 
* Started auto doc generation

* Created a markdown document

* Added test changed to md

* Created working version of new documentation

* Made requested changes

* Generate docs for all

Co-authored-by: minhhoang1023 <40023817+minhhoang1023@users.noreply.github.com>
2022-09-20 19:15:54 +01:00

1.3 KiB
Vendored
Raw Blame History

common.qa.quantile

To obtain charts, make sure to add chart=True as the last parameter

Get underlying data

###common.qa.quantile(data: pandas.core.frame.DataFrame, window: int = 14, quantile_pct: float = 0.5) -> Tuple[pandas.core.frame.DataFrame, pandas.core.frame.DataFrame]

Overlay Median & Quantile

Parameters
----------
data: pd.DataFrame
    Dataframe of targeted data
window : int
    Length of window
quantile_pct: float
    Quantile to display

Returns
-------
df_med : pd.DataFrame
    Dataframe of median prices over window
df_quantile : pd.DataFrame
    Dataframe of gievn quantile prices over window

Getting charts

###common.qa.quantile(data: pandas.core.frame.DataFrame, target: str, symbol: str = '', window: int = 14, quantile: float = 0.5, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None

View rolling quantile

Parameters
----------
data: pd.DataFrame
    Dataframe
target: str
    Column in data to look at
symbol : str
    Stock ticker
window : int
    Length of window
quantile: float
    Quantile to get
export: str
    Format to export data
external_axes: Optional[List[plt.Axes]], optional
    External axes (1 axis is expected in the list), by default None