kingchenc
32e18cb3a3
Fills the two empty r-universe tabs (**Articles**, **Datasets**) for the R package and gives R users a runnable onboarding path. ## What - **`vignettes/getting-started.Rmd`** — Articles tab. Walks through batch vs streaming (and that they're equivalent), multi-output MACD, candle ATR, and `reset()`, all over the bundled sample series. Built strictly from the already-proven README quick-start + golden-test API (`Sma`/`Ema`/`Rsi`/`Atr`/`MacdIndicator`, `batch`/`update`/`reset`) — no new indicator logic. - **`data/sample_ohlcv.rda`** (+ `data-raw/sample_ohlcv.R` generator) — Datasets tab. A deterministic, seeded synthetic daily OHLCV series (250 rows × `date/open/high/low/close/volume`); documented via `R/data.R` + `man/sample_ohlcv.Rd`. `LazyData: true` → available right after `library(wickra)`. - **`DESCRIPTION`** — `Suggests: knitr, rmarkdown`, `VignetteBuilder: knitr`, `LazyData: true`. - **`ci.yml`** — the R job now knits the vignette (executes its R chunks, no pandoc needed) so a broken example is caught **in CI** before r-universe / CRAN `R CMD check`. The main job otherwise only `R CMD INSTALL`s. ## Verified locally (R 4.6.0 + Rtools45) - Package installs with the dev C-ABI override; dataset moves to the lazyload DB. - Vignette **knits cleanly** — every chunk runs, `batch == streaming` holds, MACD/ATR/RSI produce sensible values. ## Notes - No version bump — metadata/docs only; rides the next release. Merging triggers an r-universe rebuild → Articles + Datasets populate **and** (now that `support@wickra.org` is verified) the maintainer avatar resolves. - `data-raw/` is `.Rbuildignore`d (generator, not shipped). The `.rda` is XZ-compressed (~3 KB). Not merging — for review.
28 lines
770 B
R
28 lines
770 B
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/data.R
|
|
\docType{data}
|
|
\name{sample_ohlcv}
|
|
\alias{sample_ohlcv}
|
|
\title{Synthetic daily OHLCV sample series}
|
|
\format{
|
|
A data frame with 250 rows and 6 columns:
|
|
\describe{
|
|
\item{date}{Trading date (\code{Date}).}
|
|
\item{open}{Opening price.}
|
|
\item{high}{Session high.}
|
|
\item{low}{Session low.}
|
|
\item{close}{Closing price.}
|
|
\item{volume}{Traded volume.}
|
|
}
|
|
}
|
|
\usage{
|
|
sample_ohlcv
|
|
}
|
|
\description{
|
|
A deterministic, synthetic daily OHLCV (open / high / low / close / volume)
|
|
price series for use in the examples, the \emph{Getting started} vignette, and
|
|
tests. It is a seeded random walk, \strong{not} real market data. Regenerate with
|
|
\code{data-raw/sample_ohlcv.R}.
|
|
}
|
|
\keyword{datasets}
|