Skip to main content

plot

Plot selected charts for portfolios

Usage

plot [-pf PORTFOLIOS] [-pi] [-hi] [-dd] [-rc] [-he] [-rm {MV,MAD,MSV,FLPM,SLPM,CVaR,EVaR,WR,ADD,UCI,CDaR,EDaR,MDD}] [-mt METHOD] [-ct CATEGORIES] [-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]

Parameters

NameParameterDescriptionDefaultOptionalChoices
portfolios-pf --portfoliosSelected portfolios that will be plottedTrueNone
pie-pi --pieDisplay a pie chart for weightsFalseTrueNone
hist-hi --histDisplay a histogram with risk measuresFalseTrueNone
dd-dd --drawdownDisplay a drawdown chart with risk measuresFalseTrueNone
rc_chart-rc --rc-chartDisplay a risk contribution chart for assetsFalseTrueNone
heat-he --heatDisplay a heatmap of correlation matrix with dendrogramFalseTrueNone
risk_measure-rm --risk-measureRisk 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 returnsMVTrueMV, MAD, MSV, FLPM, SLPM, CVaR, EVaR, WR, ADD, UCI, CDaR, EDaR, MDD
nan_fill_method-mt --methodMethod 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 pointstimeTruelinear, time, nearest, zero, slinear, quadratic, cubic, barycentric
categories-ct --categoriesShow selected categoriesTrueNone
historic_period-p --periodPeriod 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 asset3yTrue1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 3y, 5y, 10y, ytd, max
start_period-s --startStart date to get yfinance data from. Must be in 'YYYY-MM-DD' formatTrueNone
end_period-e --endEnd date to get yfinance data from. Must be in 'YYYY-MM-DD' formatTrueNone
log_returns-lr --log-returnsIf use logarithmic or arithmetic returns to calculate returnsFalseTrueNone
return_frequency--freqFrequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returnsdTrued, w, m
max_nan-mn --maxnanMax percentage of nan values accepted per asset to be considered in the optimization process0.05TrueNone
threshold_value-th --thresholdValue used to replace outliers that are higher to threshold in absolute value0.3TrueNone
risk_free-r --risk-free-rateRisk-free rate of borrowing/lending. The period of the risk-free rate must be annual0.05384TrueNone
significance_level-a --alphaSignificance level of CVaR, EVaR, CDaR and EDaR0.05TrueNone
long_allocation-v --valueAmount to allocate to portfolio1TrueNone

Examples

2022 Apr 26, 02:19 (🦋) /portfolio/po/ $ plot -pf maxsharpe_0 -pi -hi -dd -rc -he