summary.ichimoku: Summary of Ichimoku Strategies

Description Usage Arguments Details Value Further Details Examples

View source: R/strat.R

Description

Custom summary method for ichimoku objects for viewing strategies.

Usage

1
2
## 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 data summary instead.

...

additional arguments to be passed along.

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'.

Value

A matrix containing the strategy summary if present, otherwise a table containing the data summary.

Further Details

Please refer to the strategies vignette by running: vignette("strategies", package = "ichimoku")

Examples

1
2

ichimoku documentation built on July 22, 2021, 5:08 p.m.