esfm.Rd: list what the fit and symmetry_test() return (issue #3) - #52
Merged
Merged
Conversation
\value described only the out matrix and Efficiency. It now tabulates the components a user reaches for (gamma, sigma_v, logLik and the restricted logLik, lr_symmetry/p_symmetry, wrong_skew_sample, residual_m3, model_name), each checked against the list esfm() builds, and documents symmetry_test()'s one-row data frame, which had no \value at all. \usage is unchanged. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014oJL17ewiahA8pWbemnqNp
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
2 participants
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.
Part of the issue #3 readability pass. Only one page changes:
man/esfm.Rd.\usageis unchanged.What was missing
\valuedescribed only theoutmatrix andEfficiency.symmetry_test()shares this page, but nothing documented what it returns.Now
outgamma,sigma_vEfficiencylogLik,logLik_restrictedlr_symmetry,p_symmetrywrong_skew_sample,residual_m3model_namesymmetry_test()'s one-row data frame, with columnstest,statistic,df(always 1),nullandp.value.Each name and meaning was checked against the list
esfm()builds (R/esfm.R) and againstsymmetry_test(). The page renders cleanly withR CMD Rdconv.🤖 Generated with Claude Code
https://claude.ai/code/session_014oJL17ewiahA8pWbemnqNp
Generated by Claude Code