str.ichimoku: Display the Structure of Ichimoku Objects

In shikokuchuo/ichimoku: Visualization and Tools for Ichimoku Kinko Hyo Strategies

Display the Structure of Ichimoku Objects

Description

Compactly display the internal structure of ichimoku objects.

Usage

## S3 method for class 'ichimoku'
str(object, ...)

Arguments

object	an object of class ‘ichimoku’.
...	arguments passed to or from other methods.

Details

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

Value

Invisible NULL. A compact display of the structure of the object is output to the console.

Examples

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

strat <- strat(cloud)
str(strat)

shikokuchuo/ichimoku documentation built on Feb. 18, 2025, 9:58 p.m.