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
4e6a2fb5648d7e8ee4fdb31d1ce6ffddbaf701bf
OpenBB/website/content/api/common/qa/es/_index.md
Colin Delahunty 0b33cb45f8 Adds auto yaml generation (#2587) 
* Began working on docs creator

* Added fixes

* More

* More

* Adding autogen_try.py for OpenBB API doc generation

* OpenBB API docs gen try

* Fixed

* Added fixes

* Added fixes

* subs -> sub

* Updated docs

* Updated docs

Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
2022-09-23 16:43:34 +01:00

1.4 KiB
Vendored
Raw Blame History

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

Get underlying data

common.qa.es(data: pandas.core.frame.DataFrame, use_mean: bool = False, distribution: str = 'normal', percentile: Union[float, int] = 0.999, portfolio: bool = False) -> pandas.core.frame.DataFrame

Gets Expected Shortfall for specified stock dataframe

Parameters
----------
data: pd.DataFrame
    Data dataframe
use_mean: bool
    If one should use the data mean for calculation
distribution: str
    Type of distribution, options: laplace, student_t, normal
percentile: Union[float,int]
    VaR percentile
portfolio: bool
    If the data is a portfolio

Returns
-------
list
    list of ES
list
    list of historical ES

Getting charts

common.qa.es(data: pandas.core.frame.DataFrame, symbol: str = '', use_mean: bool = False, distribution: str = 'normal', percentile: float = 0.999, portfolio: bool = False, chart=True) -> None

Displays expected shortfall

Parameters
----------
data: pd.DataFrame
    Data dataframe
use_mean:
    if one should use the data mean return
symbol: str
    name of the data
distribution: str
    choose distribution to use: logistic, laplace, normal
percentile: int
    es percentile
portfolio: bool
    If the data is a portfolio