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.
30 lines
1.1 KiB
R
30 lines
1.1 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/indicators.R
|
|
\name{BinanceFeed}
|
|
\alias{BinanceFeed}
|
|
\title{Connect to a live Binance kline feed}
|
|
\usage{
|
|
BinanceFeed(symbols, interval, base_url = NULL)
|
|
}
|
|
\arguments{
|
|
\item{symbols}{Comma-separated trading symbols (case-insensitive), e.g.
|
|
\code{"btcusdt,ethusdt"}.}
|
|
|
|
\item{interval}{Integer interval code \code{0:15} (\code{0} = 1s, \code{1} = 1m, ...,
|
|
\code{12} = 1d, \code{13} = 3d, \code{14} = 1w, \code{15} = 1M).}
|
|
|
|
\item{base_url}{Optional endpoint override; \code{NULL} uses production.}
|
|
}
|
|
\value{
|
|
A \code{wickra_binance_feed}; poll it with \code{\link[=binance_next]{binance_next()}} and close it
|
|
with \code{\link[=binance_close]{binance_close()}}.
|
|
}
|
|
\description{
|
|
Opens a live Binance kline stream for one or more comma-separated \code{symbols}
|
|
(case-insensitive) at the given \code{interval} code (an integer \code{0:15}, the same
|
|
order as the other bindings: 0 = 1s, 1 = 1m, ... 12 = 1d, 13 = 3d, 14 = 1w,
|
|
15 = 1M). \code{base_url} overrides the endpoint (\code{NULL} = production). Not
|
|
available in the wasm (r-universe/webR) build, which has no raw sockets.
|
|
}
|
|
\keyword{internal}
|