30 lines
902 B
R
30 lines
902 B
R
|
% Generated by roxygen2: do not edit by hand
|
||
|
|
% Please edit documentation in R/methods.R
|
||
|
|
\name{update.wickra_indicator}
|
||
|
|
\alias{update.wickra_indicator}
|
||
|
|
\title{Update an indicator with one observation}
|
||
|
|
\usage{
|
||
|
|
\method{update}{wickra_indicator}(object, ...)
|
||
|
|
}
|
||
|
|
\arguments{
|
||
|
|
\item{object}{A \code{wickra_indicator} created by an indicator constructor.}
|
||
|
|
|
||
|
|
\item{...}{The observation: a single value for scalar indicators, the OHLCV
|
||
|
|
fields plus a timestamp for candle indicators, or two values for pairwise
|
||
|
|
indicators.}
|
||
|
|
}
|
||
|
|
\value{
|
||
|
|
The indicator value: a numeric scalar; a named numeric vector for
|
||
|
|
multi-output indicators (\code{NA} during warmup); a matrix of completed bars for
|
||
|
|
bar builders; or a list / numeric vector for profile indicators
|
||
|
|
(\code{NULL} during warmup).
|
||
|
|
}
|
||
|
|
\description{
|
||
|
|
Update an indicator with one observation
|
||
|
|
}
|
||
|
|
\examples{
|
||
|
|
sma <- Sma(3)
|
||
|
|
for (x in c(1, 2, 3, 4, 5)) v <- update(sma, x)
|
||
|
|
v # 4
|
||
|
|
}
|