26 lines
783 B
R
26 lines
783 B
R
|
% Generated by roxygen2: do not edit by hand
|
||
|
|
% Please edit documentation in R/methods.R
|
||
|
|
\name{read}
|
||
|
|
\alias{read}
|
||
|
|
\alias{read.wickra_indicator}
|
||
|
|
\title{Read every candle parsed by a CSV candle reader}
|
||
|
|
\usage{
|
||
|
|
read(object)
|
||
|
|
|
||
|
|
\method{read}{wickra_indicator}(object)
|
||
|
|
}
|
||
|
|
\arguments{
|
||
|
|
\item{object}{A \code{wickra_indicator} created by \code{\link[=CandleReader]{CandleReader()}}.}
|
||
|
|
}
|
||
|
|
\value{
|
||
|
|
A numeric matrix with six named columns (zero rows for an empty CSV).
|
||
|
|
}
|
||
|
|
\description{
|
||
|
|
Returns all the candles a \code{\link[=CandleReader]{CandleReader()}} parsed from its CSV, as a numeric
|
||
|
|
matrix with columns \code{open}, \code{high}, \code{low}, \code{close}, \code{volume}, \code{timestamp}.
|
||
|
|
}
|
||
|
|
\examples{
|
||
|
|
r <- CandleReader("timestamp,open,high,low,close,volume\n0,100,101,99,100.5,10\n")
|
||
|
|
read(r)
|
||
|
|
}
|