kingchencandGitHub
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.
29 lines
1.4 KiB
Plaintext
29 lines
1.4 KiB
Plaintext
Package: wickra
|
|
Type: Package
|
|
Title: Streaming-First Technical Indicators
|
|
Version: 0.8.6
|
|
Authors@R: person("Wickra contributors", role = c("aut", "cre"), email = "support@wickra.org")
|
|
Description: R bindings for the Wickra technical-analysis library over its C ABI
|
|
hub. Exposes 514 indicators, each an O(1) streaming state machine shared with
|
|
the Rust core and the other language bindings, so that live and historical
|
|
evaluation use the exact same implementation.
|
|
License: MIT + file LICENSE | Apache License 2.0
|
|
URL: https://github.com/wickra-lib/wickra, https://docs.wickra.org,
|
|
https://wickra-lib.r-universe.dev
|
|
BugReports: https://github.com/wickra-lib/wickra/issues
|
|
X-schema.org-keywords: technical-analysis, indicators, streaming, trading,
|
|
finance, quant, algorithmic-trading, backtesting, time-series, ta-lib,
|
|
candlestick, market-data
|
|
Encoding: UTF-8
|
|
NeedsCompilation: yes
|
|
SystemRequirements: the Wickra C ABI shared library, downloaded automatically at
|
|
install time from the matching GitHub release and bundled into the package.
|
|
Set WICKRA_INCLUDE_DIR and WICKRA_LIB_DIR to build against a locally built C
|
|
ABI instead (e.g. after `cargo build -p wickra-c --release`).
|
|
Roxygen: list(markdown = TRUE)
|
|
Suggests: testthat (>= 3.0.0), knitr, rmarkdown
|
|
VignetteBuilder: knitr
|
|
LazyData: true
|
|
Config/testthat/edition: 3
|
|
Config/roxygen2/version: 8.0.0
|