coredata.ichimoku: Extract the Core Data of Ichimoku Objects

View source: R/methods.R

coredataR Documentation

Extract the Core Data of Ichimoku Objects

Description

Method for extracting the core data matrix of ichimoku objects.

Usage

## S3 method for class 'ichimoku'
coredata(x, fmt, ...)

Arguments

x

an object of class 'ichimoku'.

fmt

(optional) set to TRUE to retain the index as row names of the returned matrix, or a character string passed on to the 'format' argument of format.POSIXct() to format these values in a specific way.

...

arguments passed to or from other methods.

Details

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

Value

A numeric matrix containing the ichimoku object data, stripped of the index unless 'fmt' is specified in which case the index will be retained as character values in the matrix row names.

Examples

cloud <- ichimoku(sample_ohlc_data)
coredata(cloud)[101:120, ]


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