mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-04 16:32:10 +00:00
4ad995fdd0
* 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>
50 lines
1.2 KiB
Markdown
Vendored
50 lines
1.2 KiB
Markdown
Vendored
---
|
|
title: metric
|
|
description: This page provides detailed instructions on how to display a chosen metric
|
|
for different periods. It discusses parameters such as volatility, sharpe, sortino,
|
|
etc. and how to set the risk-free rate for calculations.
|
|
keywords:
|
|
- metric
|
|
- risk free rate
|
|
- volatility
|
|
- sharpe ratio
|
|
- sortino ratio
|
|
- max drawdown
|
|
- R square
|
|
- skew
|
|
- kurtosis
|
|
- gain to pain
|
|
- tracker
|
|
- information ratio
|
|
- tail ratio
|
|
- common sense ratio
|
|
- jensens alpha
|
|
- calmar ratio
|
|
- kelly criterion
|
|
- payoff ratio
|
|
- profit factor
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="portfolio/metric - Reference | OpenBB Terminal Docs" />
|
|
|
|
Display metric of choice for different periods
|
|
|
|
### Usage
|
|
|
|
```python
|
|
metric [-m METRIC] [-r RISK_FREE_RATE]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Default | Optional | Choices |
|
|
| ---- | ----------- | ------- | -------- | ------- |
|
|
| metric | Set metric of choice | True | True | volatility, sharpe, sortino, maxdrawdown, rsquare, skew, kurtosis, gaintopain, trackerr, information, tail, commonsense, jensens, calmar, kelly, payoff, profitfactor |
|
|
| risk_free_rate | Set risk free rate for calculations. | 0 | True | None |
|
|
|
|
---
|