Files
wickra/bindings/r/man/wickra-package.Rd
T

36 lines
1.1 KiB
R
Raw Normal View History

2026-06-09 19:18:40 +02:00
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/methods.R
\docType{package}
\name{wickra-package}
\alias{wickra}
\alias{wickra-package}
\title{wickra: streaming-first technical indicators}
\description{
R bindings for the Wickra technical-analysis library over its C ABI hub. Each
indicator is a constructor (for example \code{\link[=Sma]{Sma()}}, \code{\link[=Rsi]{Rsi()}}, \code{\link[=MacdIndicator]{MacdIndicator()}})
returning a \code{wickra_indicator} object; feed it one observation at a time with
\code{\link[=update]{update()}}, run a whole series in one call with \code{\link[=batch]{batch()}}, and clear its
state with \code{\link[=reset]{reset()}}. The native handle is freed automatically when the object
is garbage-collected.
}
\seealso{
Useful links:
\itemize{
\item \url{https://github.com/wickra-lib/wickra}
\item \url{https://docs.wickra.org}
\item \url{https://wickra-lib.r-universe.dev}
2026-06-09 19:18:40 +02:00
\item Report bugs at \url{https://github.com/wickra-lib/wickra/issues}
}
}
\author{
\strong{Maintainer}: kingchenc \email{support@wickra.org}
2026-06-09 19:18:40 +02:00
Authors:
\itemize{
\item kingchenc \email{support@wickra.org}
2026-06-09 19:18:40 +02:00
}
}
\keyword{internal}