kingchencandGitHub
b7ef63400d
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.
38 lines
1.8 KiB
Markdown
38 lines
1.8 KiB
Markdown
# Roadmap
|
|
|
|
This roadmap describes the project's direction at a high level. It is
|
|
intentionally non-binding: priorities shift with feedback and available time,
|
|
and the authoritative, up-to-date view of planned work is the
|
|
[issue tracker](https://github.com/wickra-lib/wickra/issues). Shipped changes
|
|
are recorded in [`CHANGELOG.md`](CHANGELOG.md).
|
|
|
|
## Status
|
|
|
|
Wickra is **pre-1.0**. The public API is largely stable but may still change in
|
|
minor releases; breaking changes are called out in the changelog.
|
|
|
|
## Themes
|
|
|
|
- **Indicator coverage.** Continue broadening the indicator catalogue across
|
|
families (trend, momentum, volatility, volume, statistics, market profile,
|
|
and more), each with the same streaming/batch parity and test guarantees.
|
|
- **API stabilization toward 1.0.** Settle the public `Indicator` and
|
|
`BarBuilder` traits and the binding surfaces, then commit to semantic
|
|
versioning stability for a 1.0 release.
|
|
- **Performance.** Keep per-tick updates O(1) and maintain the benchmark suite;
|
|
investigate further allocation and cache improvements.
|
|
- **Bindings parity.** Keep the Python, Node.js and WebAssembly bindings — plus
|
|
the C ABI and the C# / .NET, Go and R bindings generated from it — in lockstep with the
|
|
Rust core, including type stubs and platform coverage.
|
|
- **Documentation.** Maintain a deep-dive page per indicator on
|
|
<https://docs.wickra.org>, plus quickstarts and cookbook material.
|
|
- **Project health.** Maintain test coverage, static and dynamic analysis,
|
|
signed releases, and supply-chain monitoring.
|
|
|
|
## How to influence the roadmap
|
|
|
|
Open or comment on an issue, or start with the
|
|
[feature-request template](.github/ISSUE_TEMPLATE/feature_request.md).
|
|
Well-scoped proposals and pull requests are the most effective way to move an
|
|
item forward.
|