[FBartos]

Summary

Adds a reader for FactorsForm model-terms options. It is the R side of the opt-in term specification for jasp-desktop's FactorsForm. prepareModelTerms() reads a model-terms option, with or without the term specification. For each model it returns:

• the formula (modelTermsFormula()) or the numeric design columns (modelTermsDesign());

• display labels for the fit's coefficients (modelTermsLabels());

• the offsets (modelTermsOffset(), modelTermsConstantOffset()).

• Without the term specification, the formula is exactly the one analyses built before. Analyses can switch to the reader without changing their results.

• With the term specification, terms are defined once and combined into each model's terms:

  • definitions pairs a variable with a specification;
  • terms are products of definitions.

• Catalogue: inst/modelTermSpecifications.json lists every specification once. Each entry gives its kind, whether it is offered by default or only on request, its title, its label pattern, and its parameters with their defaults. jasp-desktop embeds the same file at build time to build its table, so the desktop and R produce the same labels. To add or remove a specification, edit this file and add a builder in R/modelTerms.R; a test checks that every entry has a builder and that every label pattern fills in.

• Specifications:

  • Transformations: center, scale, logarithms, power, root, Box-Cox, Yeo-Johnson, asinh, logit, probit, arcsine square root, orthogonal and raw polynomials, natural and B-splines, hinge, threshold, quantile bins, Fourier terms, rank and normal scores, Arrhenius.
  • Codings: treatment, simple, sum, Helmert and reverse Helmert, successive and forward differences, orthogonal polynomial, SAS, indicators.
  • Offsets: an offset by a variable, or a constant offset.

• Fitting details:

  • Constants learned from the fitting data are embedded in the formula, so new data is coded the same way as the fitting data. Rank terms are flagged as sample-dependent (sampleDependent), like rank(x) in lm().
  • Categorical terms become coded matrices.
  • Supports restrictions (fixed coefficients) and nesting of consecutive models.
  • Every inconsistency stops with a message that names the model.

• Version bumped to 0.20.6.

Related PRs

• FactorsForm: opt-in term specification jasp-desktop#6404: the FactorsForm term specification. It embeds this catalogue, and its submodule points at this branch.
• Linear Regression: term specification (pilot) jaspRegression#554: Linear Regression as the pilot analysis.

Merge this PR first. The desktop PR then moves its submodule to the merged commit, and jaspRegression needs a jaspBase that has the reader.

Tests

tests/testthat/test-modelTerms.R: 103 tests, 1199 expectations, all passing. They cover:

• the basic-mode formulas;
• every catalogue entry (it has a builder, and its label pattern fills in);
• labels;
• each coding compared with lm();
• nesting, restrictions, bins, rank, and refusals.

🤖 Generated with Claude Code