plot.time.series: Plot scatterplot matrix of time-series vectors

Description Usage Arguments

View source: R/plot.time.series.R

Description

This is a custom plot function that operates on objects of class time.series (which is the output generated from the rGARMA function). This plot function generates a scatterplot matrix of time-series vectors using either ggplot or base graphics. The user must input either a single time-series vector x or a matrix x where each row is one time-series vector. The function generates a scatterplot matrix showing each of the time-series. If the plot is generated using ggplot graphics then the user has an option to include a background showing all points from all the series in grey. The user may choose to print or assign the object, or both. Since the function generates a scatterplot of time-series plots, there are certain limits in the output. If the user attempts to generate the plot for a time-series matrix with more than 36 time-series, the user will be prompted to continue and prompted about whether they want to include the background. The prompts can be removed in the arguments of the function.

Usage

1
2
3
4
5
6
7
8
9
## S3 method for class 'time.series'
plot(
  x,
  ggplot = TRUE,
  background = TRUE,
  print = TRUE,
  user.prompt = TRUE,
  ...
)

Arguments

x

A vector or matrix of time-series values (if a matrix, each time-series should be one row of the matrix)

ggplot

Logical; if TRUE the scatterplot is a ggplot object; if FALSE it is a base plot object

background

Logical; if TRUE then each ggplot scatterplot will include background points for all the time-series vectors

print

Logical; if TRUE the scatterplot is printed

user.prompt

Logical; if TRUE the user will be prompted for choices when the number if time-series is large

...

unused

#@examples

data(garma) plot(SERIES)


ts.extend documentation built on Nov. 15, 2020, 1:06 a.m.