kingchenc
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.
34 lines
1.0 KiB
R
34 lines
1.0 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/methods.R
|
|
\name{push}
|
|
\alias{push}
|
|
\alias{push.wickra_indicator}
|
|
\title{Push a trade tick into a tick aggregator}
|
|
\usage{
|
|
push(object, price, size, timestamp)
|
|
|
|
\method{push}{wickra_indicator}(object, price, size, timestamp)
|
|
}
|
|
\arguments{
|
|
\item{object}{A \code{wickra_indicator} created by \code{\link[=TickAggregator]{TickAggregator()}}.}
|
|
|
|
\item{price}{Trade price.}
|
|
|
|
\item{size}{Trade size (volume).}
|
|
|
|
\item{timestamp}{Trade timestamp, in the same unit as the aggregator bucket.}
|
|
}
|
|
\value{
|
|
A numeric matrix with six named columns (possibly zero rows).
|
|
}
|
|
\description{
|
|
Feeds one trade tick to a \code{\link[=TickAggregator]{TickAggregator()}} and returns the candles it
|
|
closed as a numeric matrix with columns \code{open}, \code{high}, \code{low}, \code{close},
|
|
\code{volume}, \code{timestamp} (zero rows while the open bar merely grows).
|
|
}
|
|
\examples{
|
|
agg <- TickAggregator(1000, FALSE)
|
|
push(agg, 100, 1, 0)
|
|
push(agg, 102, 1, 1000) # closes the first bucket
|
|
}
|