Skip to content

docs: correct model-support guidance and plotting references - #250

Open
dajiaohuang wants to merge 1 commit into
datalorax:masterfrom
dajiaohuang:repostew/fix-guide-model-support-20261016
Open

dajiaohuang wants to merge 1 commit into
datalorax:masterfrom
dajiaohuang:repostew/fix-guide-model-support-20261016

Conversation

@dajiaohuang

Copy link
Copy Markdown

What this fixes

The introduction still lists mixed-effects models as unimplemented, despite the registered extract_eq.lmerMod method and the existing lmer vignette. Replace that outdated list with a link to the implemented model's documentation, while retaining the known polynomial limitations through #214. This does not claim that every broom model or formula feature is supported.

The plotting vignette also points readers to equatiomatic::extract:eq() and latex2exp::Tex(), rather than equatiomatic::extract_eq() and latex2exp::TeX(), and lists \\being{aligned} instead of \\begin{aligned}. Following the equatiomatic function reference fails with 'extract' is not an exported object from 'namespace:equatiomatic'; the corrected call returns an equation.

Validation

  • Installed and loaded the package under R 4.3.3 on Linux.
  • Exercised small fixed-seed synthetic lm/glm models, factors, interactions, coefficients, wrapping, labels, colors and equation/knitr output.
  • Parsed R chunks in the README and the introduction, colors, Markdown/Quarto and plotting vignettes without evaluating their real-data examples.
  • R CMD build --no-build-vignettes --no-manual and git diff --check passed.

Full vignette execution, R CMD check, plotting-package integration and PDF/browser visual rendering were not run. This is a documentation-only change, not a change to statistical behavior or a claim of validating every supported model.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant