plot.fts: Functional Time Series Visualization Tools Using Plotly

View source: R/ftsplot.r

plot.ftsR Documentation

Functional Time Series Visualization Tools Using Plotly

Description

This is a plotting method for univariate or multivariate functional time series (fts). This method is designed to help the user visualize fts data using a variety of techniques that use plotly.

Usage

## S3 method for class 'fts'
plot(
  x,
  vars = NULL,
  types = NULL,
  subplot = TRUE,
  mains = NULL,
  ylabels = NULL,
  xlabels = NULL,
  tlabels = NULL,
  zlabels = NULL,
  xticklabels = NULL,
  xticklocs = NULL,
  yticklabels = NULL,
  yticklocs = NULL,
  color_palette = "RdYlBu",
  reverse_color_palette = FALSE,
  ...
)

Arguments

x

An object of class fts.

vars

A numeric specifying which variables in the fts to plot. The default is to plot all variables in succession. Note as well that variable indices may be repeated.

types

A tuple of strings specifying the types of plots to be displayed where possible types for fts variables observed over a one-dimensional domain are:

  • "line" - plot the fts elements in a line plot (default)

  • "heatmap" - plot the fts elements in a heat map which can be used for variables observed over one or two-dimensional domains

  • "3Dsurface" - plot the fts elements as a surface

  • "3Dline" - plot the fts elements in a three-dimensional line plot.

The current plot type supported for fts variables observed over a two-dimensional domain is "heatmap". Also note that the same variable may be plotted several times using many different type options.

subplot

A logical specifying whether or not line plots should be plotted in a subplot or not. The default is TRUE and if any other plot type is provided, the value is switched to FALSE.

mains

A tuple of strings providing the the main titles of each plot.

ylabels

A tuple of strings providing the the y-axis titles of each plot.

xlabels

A tuple of strings providing the the x-axis titles of each plot.

tlabels

A tuple of strings providing the the time-axis titles of each plot.

zlabels

A tuple of strings providing the the z-axis titles of each plot.

xticklabels

A list of character vectors where each entry specifies the tick labels for the domain of the functions.

xticklocs

A list of numerics where each entry specifies the position of the tick labels for the domain of the functions.

yticklabels

A list of character vectors where each entry specifies the tick labels for the domain of the functions.

yticklocs

A list of numerics where each entry specifies the position of the tick labels for the domain of the functions.

color_palette

A string specifying the color palette that is offered by the ggplot2 package to be used when plotting fts variables observed over two-dimensional domains.

reverse_color_palette

A boolean specifying if the color palette scale should be reversed.

...

arguments to be passed to methods, such as graphical parameters.

Note

For examples, see fssa


Rfssa documentation built on Sept. 9, 2022, 1:07 a.m.