mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-08 18:32:21 +00:00
79046608b6
* Update generate_terminal_markdown.py * updates * update workflows * Automated Change * tests * tests * Automated Change * Update test_generate_docs.py * Automated Change * updates * Automated Change * Update gen-docs.yml * Update test.yml * Automated Change * Update test.yml * Automated Change * Update generate_sdk_markdown.py * Automated Change * test * Automated Change * testtt23 * Automated Change * Update generate_sdk_markdown.py * Automated Change * Automated Change * added empting reference folders before autogen docs * updates * Automated Change * update tests gitactions * Automated Change * up * Automated Change * Automated Change * update pytest * Automated Change * tests * Automated Change * examples update * Automated Change * Update generate_sdk_markdown.py * Automated Change * Update test.yml * Update generate_sdk_markdown.py * strip * Automated Change * Workflow : check test update * Automated Change * Automated Change * Automated Change * Update test.yml * Automated Change * Update test.yml * Automated Change * Automated Change * up * Automated Change * Update generate_sdk_markdown.py * Automated Change * update workflows * fix guides * testing * Update gh-pages.yml * Update gh-pages.yml Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com> Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com> Co-authored-by: Chavithra PARANA <chavithra@gmail.com> Co-authored-by: Chavithra <Chavithra@users.noreply.github.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
47 lines
1.6 KiB
Markdown
Vendored
47 lines
1.6 KiB
Markdown
Vendored
---
|
|
title: es
|
|
description: OpenBB Terminal Function
|
|
---
|
|
|
|
# es
|
|
|
|
Provides Expected Shortfall (short: ES) of the selected portfolio.
|
|
|
|
### Usage
|
|
|
|
```python
|
|
es [-m] [-d DIST] [-p PERCENTILE]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Default | Optional | Choices |
|
|
| ---- | ----------- | ------- | -------- | ------- |
|
|
| use_mean | If one should use the mean of the portfolios return | True | True | None |
|
|
| distribution | Distribution used for the calculations | normal | True | laplace, student_t, logistic, normal |
|
|
| percentile | Percentile used for ES calculations, for example input 99.9 equals a 99.9 Percent Expected Shortfall | 99.9 | True | None |
|
|
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
2022 Feb 25, 03:09 (🦋) /portfolio/ $ es
|
|
Portfolio Expected Shortfall
|
|
┏━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━┓
|
|
┃ ┃ ES: ┃ Historical ES: ┃
|
|
┡━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━┩
|
|
│ 90.0% │ -0.0204 │ -0.0202 │
|
|
├───────┼─────────┼────────────────┤
|
|
│ 95.0% │ -0.0240 │ -0.0242 │
|
|
├───────┼─────────┼────────────────┤
|
|
│ 99.0% │ -0.0310 │ -0.0270 │
|
|
├───────┼─────────┼────────────────┤
|
|
│ 99.9% │ -0.0391 │ -0.0277 │
|
|
└───────┴─────────┴────────────────┘
|
|
```
|
|
---
|