chart.Scatter {PerformanceAnalytics}R Documentation

wrapper to draw scatter plot with sensible defaults

Description

Draws a scatter chart. This is another chart "primitive", since it only contains a set of sensible defaults. This function is intended to be used in a wrapper that is written for a particular purpose. This is just a handy way to standardize the formatting of multiple charts.

Usage

chart.Scatter(x, y, reference.grid = TRUE, main = "Title", ylab=NULL, xlab=NULL, xlim = NA, ylim = NA, colorset = 1, symbolset = 1, darken = FALSE , legend.loc = NULL, ylog = FALSE, cex.axis = 0.8, cex.legend = 0.8,...)

Arguments

x data for the x axis, can take matrix,vector, or timeseries
y data for the y axis, can take matrix,vector, or timeseries
reference.grid if true, draws a grid aligned with the points on the x and y axes
main set the chart title, same as in plot
ylab set the y-axis label, as in plot
xlab set the x-axis label, as in plot
xlim set the x-axis limit, same as in plot
ylim set the y-axis limit, same as in plot
colorset color palette to use, set by default to rational choices
symbolset from pch in plot, submit a set of symbols to be used in the same order as the data sets submitted
darken if true, draws the chart elements in "darkgray" rather than "gray". Makes it easier to print for some printers.
legend.loc places a legend into one of nine locations on the chart: bottomright, bottom, bottomleft, left, topleft, top, topright, right, or center.
ylog TRUE/FALSE set the y-axis to logarithmic scale, similar to plot, default FALSE
cex.axis The magnification to be used for axis annotation relative to the current setting of 'cex', same as in plot.
cex.legend The magnification to be used for sizing the legend relative to the current setting of 'cex'.
... any other passthru parameters

Value

Draws a graph of type "scatter" with some sensible defaults.

Note

Most inputs are the same as "plot" and are principally included so that some sensible defaults could be set.

Author(s)

Peter Carl

See Also

plot

Examples

data(edhec)
chart.Scatter(edhec[,1],edhec[,2])

[Package PerformanceAnalytics version 0.9.7.1 Index]