Files
OpenBB/website/content/terminal/reference/portfolio/po/equal.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

4.8 KiB
Vendored

title, description, keywords
title description keywords
equal The page provides information about an equally weighted portfolio optimization command 'equal'. It lists and explains the parameters for usage like risk measure, nan fill method, return frequency, and more. The page is useful for individuals looking for information about portfolio optimization and the usage of specific financial indicators.
docusaurus
equally weighted portfolio
portfolio optimization
risk measure
nan fill method
historic period
log returns
return frequency
risk-free rate
significance level
allocation
financial data analysis

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

Returns an equally weighted portfolio

Usage

equal [-rm {MV,MAD,MSV,FLPM,SLPM,CVaR,EVaR,WR,ADD,UCI,CDaR,EDaR,MDD}] [-mt METHOD] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-r RISK_FREE] [-a SIGNIFICANCE_LEVEL] [-v LONG_ALLOCATION] [--name NAME]

Parameters

Name Description Default Optional Choices
risk_measure Risk measure used to optimize the portfolio. Possible values are: 'MV' : Variance 'MAD' : Mean Absolute Deviation 'MSV' : Semi Variance (Variance of negative returns) 'FLPM' : First Lower Partial Moment 'SLPM' : Second Lower Partial Moment 'CVaR' : Conditional Value at Risk 'EVaR' : Entropic Value at Risk 'WR' : Worst Realization 'ADD' : Average Drawdown of uncompounded returns 'UCI' : Ulcer Index of uncompounded returns 'CDaR' : Conditional Drawdown at Risk of uncompounded returns 'EDaR' : Entropic Drawdown at Risk of uncompounded returns 'MDD' : Maximum Drawdown of uncompounded returns MV True MV, MAD, MSV, FLPM, SLPM, CVaR, EVaR, WR, ADD, UCI, CDaR, EDaR, MDD
nan_fill_method Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points time True linear, time, nearest, zero, slinear, quadratic, cubic, barycentric
historic_period Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset 3y True 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max
start_period Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format True None
end_period End date to get yfinance data from. Must be in 'YYYY-MM-DD' format True None
log_returns If use logarithmic or arithmetic returns to calculate returns False True None
return_frequency Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns d True d, w, m
max_nan Max percentage of nan values accepted per asset to be considered in the optimization process 0.05 True None
threshold_value Value used to replace outliers that are higher to threshold in absolute value 0.3 True None
risk_free Risk-free rate of borrowing/lending. The period of the risk-free rate must be annual 0.02924 True None
significance_level Significance level of CVaR, EVaR, CDaR and EDaR 0.05 True None
long_allocation Amount to allocate to portfolio 1 True None
name Save portfolio with personalized or default name NAME_0 True None

Examples

2022 Apr 05, 14:52 (🦋) /portfolio/po/ $ equal

 [3 Years] Equally Weighted Portfolio

     Weights
┏━━━━━━┳━━━━━━━━━┓
┃      ┃ Value   ┃
┡━━━━━━╇━━━━━━━━━┩
│ AAPL │ 14.28 % │
├──────┼─────────┤
│ AMZN │ 14.28 % │
├──────┼─────────┤
│ BA   │ 14.28 % │
├──────┼─────────┤
│ FB   │ 14.28 % │
├──────┼─────────┤
│ MSFT │ 14.28 % │
├──────┼─────────┤
│ T    │ 14.28 % │
├──────┼─────────┤
│ TSLA │ 14.28 % │
└──────┴─────────┘

Annual (by 252) expected return: 35.70%
Annual (by √252) volatility: 29.50%
Sharpe ratio: 1.2041