autoplot.ichimoku: Plot Ichimoku Objects with ggplot2

View source: R/plot.R

autoplotR Documentation

Plot Ichimoku Objects with ggplot2

Description

Plot Ichimoku Kinko Hyo cloud charts from ichimoku objects.

Usage

## S3 method for class 'ichimoku'
autoplot(
  object,
  window,
  ticker,
  subtitle,
  theme = c("original", "conceptual", "dark", "fresh", "mono", "solarized"),
  strat = TRUE,
  type = c("none", "r", "s", "bar", "line"),
  custom,
  ...
)

Arguments

object

an object of class 'ichimoku'.

window

(optional) a date-time window to subset the plot, in ISO-8601 compatible range strings of the format used for 'xts' objects, for example "2020-02-15/2020-08-15" or "2020-02-15/", "/2020-08" or "2020-07".

ticker

(optional) specify a ticker (or other text) to include in the chart heading. If not set, the ticker saved within the ichimoku object will be used.

subtitle

(optional) specify a subtitle to display under the chart title.

theme

[default 'original'] with further choices of 'conceptual', 'dark', 'fresh', 'mono', or 'solarized'. Alternatively, supply a vector of 12 colour values (hex codes or names) as a user-defined theme.

strat

[default TRUE] if the ichimoku object contains a strategy, the periods for which the strategy results in a position will be shaded, and the strategy printed as the chart subtitle (if not otherwise specified). Set to FALSE to turn off this behaviour.

type

[default 'none'] type of sub-plot to display beneath the ichimoku cloud chart, with a choice of 'none', 'r' or 's' for the corresponding oscillator type, and 'bar' or 'line' for custom plots.

custom

(optional) character string (containing a regular expression) matching the column name of the variable to be displayed as sub-plot. Specify type = 'bar' or type = 'line', otherwise other type settings will take precedence.

...

other arguments not used by this method.

Details

This function is an S3 method for the generic function autoplot() for class 'ichimoku'. It can be invoked by calling autoplot(x) on an object 'x' of class 'ichimoku'.

Value

A ggplot2 object with S3 classes 'gg' and 'ggplot'.


ichimoku documentation built on May 23, 2022, 9:05 a.m.