plot_metrics_2funds: Plot One Performance Metric vs. Another for 2-Fund Portfolios

In vandomed/stocks: Stock Market Analysis

Description

Useful for visualizing the behavior of 2-fund portfolios, e.g. by plotting a measure of growth vs. a measure of volatility.

Usage

plot_metrics_2funds(
  metrics = NULL,
  formula = mean ~ sd,
  tickers = NULL,
  ...,
  points = seq(0, 100, 10),
  gains = NULL,
  prices = NULL,
  benchmark = "SPY",
  y.benchmark = benchmark,
  x.benchmark = benchmark,
  ref.tickers = NULL,
  plotly = FALSE,
  title = NULL,
  base_size = 16,
  label_size = 5,
  return = "plot"
)

Arguments

metrics	Data frame with Fund column and column for each metric you want to plot. Typically the result of a prior call to calc_metrics_2funds.
formula	Formula specifying what to plot, e.g. mean ~ sd, cagr ~ mdd, or sharpe ~ allocation. See ?calc_metrics for list of metrics to choose from ("allocation" is an extra option here). If you specify metrics, default behavior is to use mean ~ sd unless either is not available, in which case the first two performance metrics that appear as columns in metrics are used.
tickers	Character vector of ticker symbols, where the first two are are a two-fund pair, the next two are another, and so on.
...	Arguments to pass along with tickers to load_gains.
points	Numeric vector specifying allocations to include as points on the curve. Set to NULL for none (0 and 100 will still be included).
gains	Data frame with a date variable named Date and one column of gains for each fund.
prices	Data frame with a date variable named Date and one column of prices for each fund.
benchmark, y.benchmark, x.benchmark	Character string specifying which fund to use as benchmark for metrics (if you request alpha, alpha.annualized, beta, or r.squared).
ref.tickers	Character vector of ticker symbols to include on the plot.
plotly	Logical value for whether to convert the ggplot to a plotly object internally.
title	Character string.
base_size	Numeric value.
label_size	Numeric value.
return	Character string specifying what to return. Choices are "plot", "data", and "both".

Value

Depending on return, a ggplot object, a data frame, or a list containing both.

Examples

## Not run: 
# Plot mean vs. SD for UPRO/VBLTX, and compare to SPY
plot_metrics_2funds(
  formula = mean ~ sd,
  tickers = c("UPRO", "VBLTX")
)

# Plot CAGR vs. max drawdown for AAPL/GOOG and FB/TWTR
plot_metrics_2funds(
  formula = cagr ~ mdd,
  tickers = c("AAPL", "GOOG", "FB", "TWTR")
)

# Plot Sharpe ratio vs. allocation for SPY/TLT
plot_metrics_2funds(
  formula = sharpe ~ allocation,
  tickers = c("SPY", "TLT")
)

## End(Not run)

vandomed/stocks documentation built on July 22, 2020, 3:25 a.m.