Improve documentation for CRAN resubmission - #15
Merged
Conversation
The one-line descriptions gave CRAN reviewers and jamovi users little to go on -- and the moderation one said 'mediation', a copy-paste error that propagated into mod.Rd and the module menu. Describe what each analysis estimates, the centering and estimation choices, and the available outputs. Cite Rosseel (2012) and Sobel (1982) with DOIs in the DESCRIPTION, the reference format CRAN reviewers ask for.
The invisible Preformatted carrier element showed up in the generated Rd value section as 'results$model ... invisible element', which is meaningless to R users. The main estimates table already has exactly the cache key as its clearWith, so carry the cached lavaan estimates in its state instead and drop the extra element.
The hand-written roxygen block above the _PACKAGE sentinel overrode the auto-generated title and description, so ?medmod still showed the pre-1.2.0 text. Let _PACKAGE pull both from the DESCRIPTION instead, keeping only the med/mod function index as details.
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
1 participant
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.
Summary
Pre-empts the two most common CRAN reviewer requests and cleans up the generated R docs, following the win-builder pass.
Expand analysis descriptions and add references
med/moddescriptions grow from one line to a real summary of what each analysis estimates, the estimation options, and the available outputs — this flows into the Rd files and the jamovi menumod.Rdand the module manifest<doi:10.18637/jss.v048.i02>and Sobel (1982)<doi:10.2307/270723>— theAuthors (year) <doi:...>format CRAN reviewers ask forCache estimates in the main table state
modelcarrier element leaked into the Rd\valuesection as "results$model — invisible element whose state caches...", meaningless to R usersclearWith, so the cached lavaan estimates now ride in its state instead; the extra element is gone from the results object and the docsVerification
R CMD check --as-cran: 1 NOTE (the unavoidable new-submission/archived one)After merge
Move the
v1.2.0tag to the merged commit and rebuild the submission tarball — nothing has shipped to CRAN yet, so the fresh tag is free.