kingchencandGitHub
7e5d394f2a
Clears the R CMD check **WARNING**s r-universe surfaced when it finally built 0.9.5 (it was stuck on 0.9.2, before the data layer existed): 11/13 platform builds reported the same two warnings. ### Warnings fixed 1. **Undocumented code objects** — the data layer added in 0.9.3 (`BinanceFeed`, `CandleReader`, `Resampler`, `TickAggregator`, `fetch_binance_klines` and the generics `name` / `is_ready` / `warmup_period` / `push` / `read`). The roxygen blocks existed in `methods.R`, but the `man/*.Rd` were never regenerated, and the constructors had only a title. 2. **Codoc mismatch** — `AwesomeOscillatorHistogram.Rd` still documented `sma_period` after the argument was renamed to `lookback`. ### Changes - Full `@param`/`@return` roxygen on the seven data-layer constructors. - Regenerated `man/*.Rd` + `NAMESPACE` with roxygen2: 13 new pages, the stale AwesomeOscillator usage refreshed, and `flush` registered on `base::flush`. - Fixed the `push()` example (`TickAggregator(1000)` was missing the required `gap_fill`) — it only ran once `push()` got a generated `.Rd`. - **New CI gate:** a ubuntu-only `R CMD check` in the `r` job that fails on doc WARNING/ERROR, so stale docs fail the PR instead of reaching r-universe. Verified locally with `R CMD check` (R 4.6.0 + Rtools45): *missing documentation entries* and *Rd \usage sections* now **OK**, examples **OK**, tests **OK**. This PR's own CI exercises the new gate. Follow-up: a separate `0.9.6` release ships these doc fixes to r-universe.
36 lines
1.2 KiB
R
36 lines
1.2 KiB
R
% 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}
|
|
\item Report bugs at \url{https://github.com/wickra-lib/wickra/issues}
|
|
}
|
|
|
|
}
|
|
\author{
|
|
\strong{Maintainer}: Wickra contributors \email{support@wickra.org}
|
|
|
|
Authors:
|
|
\itemize{
|
|
\item Wickra contributors \email{support@wickra.org}
|
|
}
|
|
|
|
}
|
|
\keyword{internal}
|