Add the R binding over the C ABI hub (#230)
Adds an R binding (`bindings/r`) over the C ABI hub — the third language stecker after C# and Go, reaching the hub through R's native `.Call` interface (not extendr). ## What's here - **`bindings/r`** — an R package exposing all 514 indicators as constructors that return a `wickra_indicator` object with generic `update`/`batch`/`reset` methods. The C glue (`src/wickra.c`) and R wrappers (`R/indicators.R`) are generated from `bindings/c/include/wickra.h` (same archetype taxonomy as the C#/Go generators: scalar/batch, multi-output, bars, profile, profile-values, array-input). The opaque handle is an R external pointer freed by a registered finalizer; multi-output returns a named vector (`NA` at warmup), bars a matrix, profiles a list. - **`examples/r`** — the full example suite mirroring C/C#/Go: streaming, backtest, multi_timeframe, parallel_assets (`mclapply`), three strategies, and `fetch_btcusdt`/`live_binance`. - **CI** — an `r` job builds the C ABI library, installs the package, runs the `testthat` suite and the offline examples on Linux, macOS and Windows (`R CMD check` is clean: 0 warnings, 0 notes). - **Docs** — R added to the README languages table, project layout, building/testing, CONTRIBUTING binding table + regenerate note, ARCHITECTURE, examples index, issue/PR templates, the About-description template, and the other binding READMEs. ## Linking / distribution The package compiles a thin `.Call` glue layer against the prebuilt C ABI library (header via `WICKRA_INCLUDE_DIR`, library via `WICKRA_LIB_DIR`). On Windows the package's own `wickra.dll` would collide with the C ABI's `wickra.dll`, so `configure.win` stages a renamed copy (`wickra_abi.dll`) and builds an import library referencing it; `install.libs.R` bundles the DLL and `.onLoad` puts it on the load path. On Linux/macOS the rpath locates the shared library. No `release.yml` change — R is distributed via r-universe / source install (gated). No Rust crate or `Cargo.toml` change — the R package is standalone and additive.
This commit is contained in:
kingchenc
@@ -0,0 +1,85 @@
|
||||
# Wickra — R
|
||||
|
||||
[](https://github.com/wickra-lib/wickra/actions/workflows/ci.yml)
|
||||
[](https://codecov.io/gh/wickra-lib/wickra)
|
||||
[](https://github.com/wickra-lib/wickra#license)
|
||||
|
||||
**Streaming-first technical indicators for R, over the Wickra C ABI hub via `.Call`.**
|
||||
|
||||
Wickra is a multi-language technical-analysis library with a Rust core and
|
||||
bindings for Python, Node.js and WebAssembly, plus a C ABI for C/C++, C#, Go, R
|
||||
and any other C-capable language. Every indicator is an O(1) streaming state
|
||||
machine, so live trading and historical backtests share the exact same
|
||||
implementation. This package is the R binding; it reaches the C ABI hub through
|
||||
R's native `.Call` interface and exposes all 514 indicators as constructors that
|
||||
return a lightweight `wickra_indicator` object.
|
||||
|
||||
## Install
|
||||
|
||||
The package compiles a thin C glue layer (`.Call`) against the prebuilt Wickra
|
||||
C ABI library, so a C toolchain (Rtools on Windows) is required, plus the C ABI
|
||||
header and library. Build the library from the workspace, then install the
|
||||
package pointing at it:
|
||||
|
||||
```bash
|
||||
cargo build -p wickra-c --release
|
||||
WICKRA_INCLUDE_DIR="$PWD/bindings/c/include" \
|
||||
WICKRA_LIB_DIR="$PWD/target/release" \
|
||||
R CMD INSTALL bindings/r
|
||||
```
|
||||
|
||||
On Windows the C ABI DLL is bundled into the package and put on the load path
|
||||
automatically; on Linux and macOS the library path is baked in via rpath.
|
||||
|
||||
## Quick start
|
||||
|
||||
```r
|
||||
library(wickra)
|
||||
|
||||
# Batch: run an indicator over a whole series (NaN at warmup positions).
|
||||
prices <- 100 + (0:999) * 0.1
|
||||
sma <- Sma(20)
|
||||
values <- batch(sma, prices)
|
||||
|
||||
# Streaming: the same indicator, fed one observation at a time in O(1).
|
||||
rsi <- Rsi(14)
|
||||
for (price in prices) {
|
||||
v <- update(rsi, price) # NaN during warmup
|
||||
if (!is.na(v) && v > 70) message("overbought")
|
||||
}
|
||||
|
||||
# Multi-output indicators return a named vector (NA while warming up).
|
||||
macd <- MacdIndicator(12, 26, 9)
|
||||
update(macd, 42) # c(macd = NA, signal = NA, histogram = NA)
|
||||
```
|
||||
|
||||
`batch(ind, prices)` and feeding the same prices through `update()` produce
|
||||
identical values — the equivalence is enforced by the test suite. Candle-input
|
||||
indicators take the OHLCV fields plus a timestamp, e.g.
|
||||
`update(atr, open, high, low, close, volume, timestamp)`. The native handle is
|
||||
freed automatically when the object is garbage-collected.
|
||||
|
||||
## Documentation
|
||||
|
||||
The full indicator catalogue, guides, quickstarts, and API reference live in the
|
||||
main repository and documentation site:
|
||||
|
||||
- **Repository & full indicator list:** <https://github.com/wickra-lib/wickra>
|
||||
- **Docs** (quickstarts, cookbook, TA-Lib migration): <https://docs.wickra.org>
|
||||
- **Runnable examples:** [`examples/r/`](https://github.com/wickra-lib/wickra/tree/main/examples/r)
|
||||
|
||||
Wickra ships native bindings for Python, Node.js, WebAssembly and Rust, plus a
|
||||
C ABI hub that any C-capable language (C, C++, C#, Go, Java, R) links against —
|
||||
all exposing the same indicators from the shared, `unsafe`-forbidden Rust core.
|
||||
|
||||
## Disclaimer
|
||||
|
||||
Wickra is an indicator toolkit, not a trading system. The values it computes are
|
||||
deterministic transforms of the input data — they are not financial advice and
|
||||
do not predict the market. Any use in a live trading context is at your own risk.
|
||||
The library is provided **as is**, without warranty of any kind.
|
||||
|
||||
## License
|
||||
|
||||
Licensed under either of [Apache-2.0](https://github.com/wickra-lib/wickra/blob/main/LICENSE-APACHE)
|
||||
or [MIT](https://github.com/wickra-lib/wickra/blob/main/LICENSE-MIT) at your option.
|
||||
Reference in New Issue
Block a user