stocks (version 1.1.4)

gains_graph: Scatterplot of Investment Gains

Description

Useful for visualizing relationship between one (or several) investments and a benchmark. First fund in tickers, gains, or prices is used as the benchmark.

Usage

gains_graph(tickers = NULL, ..., gains = NULL, prices = NULL,
  orders = 1, add.plot = FALSE, include.legend = TRUE, colors = NULL,
  lty = NULL, plot.list = NULL, points.list = NULL, legend.list = NULL,
  pdf.list = NULL, bmp.list = NULL, jpeg.list = NULL, png.list = NULL,
  tiff.list = NULL)

Arguments

tickers

Character vector of ticker symbols that Yahoo! Finance recognizes, if you want to download data on the fly.

...

Arguments to pass along with tickers to load_gains.

gains

Numeric matrix with 1 column of gains for each investment (can be a vector if there is only one).

prices

Numeric matrix with 1 column of prices for each investment (can be a vector if there is only one).

orders

Numeric vector specifying the orders of linear regression models for each y-axis investment. Set to 1 for simple linear regression, 2 for linear regression with first- and second-order terms, and so on.

add.plot

Logical value for whether to add plot data to current plot frame rather than open a new one.

include.legend

Logical value.

colors

Character vector of colors for each curve.

lty

Numeric vector specifying line types for each curve.

plot.list

List of arguments to pass to plot.

points.list

List of arguments to pass to points.

legend.list

List of arguments to pass to legend.

pdf.list

List of arguments to pass to pdf.

bmp.list

List of arguments to pass to bmp.

jpeg.list

List of arguments to pass to jpeg.

png.list

List of arguments to pass to png.

tiff.list

List of arguments to pass to tiff.

Value

In addition to the graph, a list containing fitted linear regression models returned by lm for each investment vs. the benchmark.

References

Ryan, J.A. and Ulrich, J.M. (2017) quantmod: Quantitative Financial Modelling Framework. R package version 0.4-12, https://CRAN.R-project.org/package=quantmod.

Examples

# NOT RUN {
# Plot daily gains for SSO and UPRO vs. VFINX
fig <- gains_graph(c("VFINX", "SSO", "UPRO"))
# }
# NOT RUN {
# }