Repository navigation
docs: correct model-support guidance and plotting references - #250
Open
dajiaohuang wants to merge 1 commit into
Open
dajiaohuang wants to merge 1 commit into
dajiaohuang wants to merge 1 commit into
Conversation
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this fixes
The introduction still lists mixed-effects models as unimplemented, despite the registered
extract_eq.lmerModmethod 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()andlatex2exp::Tex(), rather thanequatiomatic::extract_eq()andlatex2exp::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
R CMD build --no-build-vignettes --no-manualandgit diff --checkpassed.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.