print.ichimoku: Print Ichimoku Objects

View source: R/methods.R

print.ichimokuR Documentation

Print Ichimoku Objects

Description

Default print method for ichimoku objects to enable automatic plotting of the ichimoku cloud chart.

Usage

## S3 method for class 'ichimoku'
print(x, plot = TRUE, ...)

Arguments

x

an object of class 'ichimoku'.

plot

[default TRUE] set to FALSE to prevent automatic plotting of the ichimoku cloud chart.

...

additional arguments passed along to print.tbl and plot.ichimoku functions.

Details

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

Value

The ichimoku object supplied (invisibly). The data is printed to the console. The ichimoku cloud chart is also output to the graphical device depending on the parameters set.

Examples

cloud <- ichimoku(sample_ohlc_data, ticker = "TKR")

print(cloud)
print(cloud, plot = FALSE, n = 20)


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