summary.ichimoku: Summary of Ichimoku Objects and Strategies

View source: R/methods.R

summary.ichimokuR Documentation

Summary of Ichimoku Objects and Strategies

Description

Display summary information for an ichimoku object or its strategy.

Usage

## S3 method for class 'ichimoku'
summary(object, strat = TRUE, ...)

Arguments

object

an object of class 'ichimoku'.

strat

[default TRUE] to show the strategy summary if present. Set to FALSE to show the object summary instead.

...

arguments passed to or from other methods.

Details

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

Performs basic validation for an ichimoku object and will inform if an ichimoku object contains invalid information.

Value

A matrix containing the strategy summary, if present and 'strat' is set to TRUE, otherwise a character vector containing an abbreviated object summary (the full object summary is output to the console).

Examples

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

strat <- strat(cloud)
summary(strat)


ichimoku documentation built on July 4, 2022, 5:07 p.m.