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.
42 lines
1.5 KiB
R
42 lines
1.5 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/indicators.R
|
|
\name{fetch_binance_klines}
|
|
\alias{fetch_binance_klines}
|
|
\title{Fetch historical Binance klines over REST}
|
|
\usage{
|
|
fetch_binance_klines(
|
|
symbol,
|
|
interval,
|
|
limit,
|
|
start_ms = -1,
|
|
end_ms = -1,
|
|
base_url = NULL
|
|
)
|
|
}
|
|
\arguments{
|
|
\item{symbol}{Trading symbol (case-insensitive), e.g. \code{"btcusdt"}.}
|
|
|
|
\item{interval}{Integer interval code \code{0:15} (see \code{\link[=BinanceFeed]{BinanceFeed()}}).}
|
|
|
|
\item{limit}{Number of klines to fetch (\code{1:1000}).}
|
|
|
|
\item{start_ms, end_ms}{Optional inclusive Unix-millisecond bounds; a negative
|
|
value means unset.}
|
|
|
|
\item{base_url}{Optional host override; \code{NULL} uses production.}
|
|
}
|
|
\value{
|
|
An \verb{n x 6} numeric matrix with columns \code{open}, \code{high}, \code{low},
|
|
\code{close}, \code{volume}, \code{timestamp}.
|
|
}
|
|
\description{
|
|
Downloads up to \code{limit} (\code{1:1000}) historical klines for \code{symbol} at the given
|
|
\code{interval} code (an integer \code{0:15}, the same order as the other bindings).
|
|
\code{start_ms}/\code{end_ms} are optional inclusive Unix-millisecond bounds (a negative
|
|
value means unset); \code{base_url} overrides the host (\code{NULL} = production). Returns
|
|
an \verb{n x 6} numeric matrix with columns \code{open}, \code{high}, \code{low}, \code{close},
|
|
\code{volume}, \code{timestamp}. Blocks until the response arrives. Not available in the
|
|
wasm (r-universe/webR) build, which has no raw sockets.
|
|
}
|
|
\keyword{internal}
|