R Usage¶

Install Dependencies¶

From the repository root, install the packages needed by the R implementation and tests:

make r-setup

This installs pkgload, testthat, jsonlite, and R polars into the local .r-lib directory by default.

You can also install the packages from an R session:

install.packages(c("pkgload", "testthat", "jsonlite"))
Sys.setenv(NOT_CRAN = "true")
install.packages(
  "polars",
  repos = c(
    "https://community.r-multiverse.org",
    "https://rpolars.r-universe.dev",
    "https://cloud.r-project.org"
  )
)

On Ubuntu/Debian, install build dependencies first if R package compilation fails:

sudo apt-get update
sudo apt-get install -y build-essential cmake libcurl4-openssl-dev libssl-dev libuv1-dev libxml2-dev

Load The Local Package¶

From the repository root:

pkgload::load_all("R", export_all = TRUE)
library(polars)

This loads the implementation from R/R/derived_variables.R.

Run Derived Variables¶

Current entrypoint shape in the R package:

compehndly_apply(function_name, ..., .params = list())

For example, normalize a measured value by specific gravity:

measured <- pl$Series("measured", c(50.0, 100.0, 75.0))
sg <- pl$Series("sg_measured", c(1.020, 1.015, 1.025))

out <- compehndly_apply(
  "normalize_specific_gravity",
  measured = measured,
  sg_measured = sg,
  .params = list(sg_ref = 1.024)
)

as.vector(out)

Bin decoding uses the same numbered pair contract as Python:

values <- pl$Series("values", c(-10.0, 1.25, -3.0, 4.5))
copy_a <- pl$Series("copy_from_1", c(10.0, 20.0, 30.0, 40.0))
copy_b <- pl$Series("copy_from_2", c(50.0, 60.0, 70.0, 80.0))

out <- compehndly_apply(
  "bin_decoding",
  values = values,
  copy_from_1 = copy_a,
  copy_from_2 = copy_b,
  .params = list(filter_value_1 = -10.0, filter_value_2 = -3.0)
)

as.vector(out)

Run R Tests¶

The R tests include shared conformance vectors from shared/conformance/derived_variables_cases.json.

From the repository root:

make r-test

Or from R:

testthat::test_dir("R/tests/testthat")