Address CRAN reviewer feedback for 0.4.1#4
Merged
Conversation
DESCRIPTION: add references for the implemented methods
(Rubner/Tomasi/Guibas 2000, Swain/Ballard 1991, Puzicha/Hofmann/Buhmann
1997, Scott 2015) in the <doi:...>/ISBN: form CRAN requires.
man/*.Rd: add \value to every exported function. The plotting helpers
explicitly document that they have no return value and are called for
their side effect.
man/dtrace.Rd: drop \dontrun{} and use the bundled
inst/extdata/buildkernel-readsize-dtrace.txt sample so the example is
runnable without a live DTrace install. man/informationloss.Rd:
unwrap PlotKSDCC and PlotEMDCC from \dontrun{}; they are quick.
vignettes: capture par() and options() at the top and restore at the
end of HistogramTools.Rnw and HistogramTools-quickref.Rnw, so building
the vignettes no longer mutates the user's graphics parameters or
options.
Bumps Version to 0.4.1 and adds a NEWS.md entry describing the changes.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Owner
Author
Verification (after installing
|
Adds the standard cran-comments.md documenting the reviewer points addressed in 0.4.1, the test environments exercised, and the expected R CMD check note about the prior archival. Updates the DESCRIPTION Date to today and adds cran-comments.md to .Rbuildignore so it is not shipped in the source tarball.
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.
Summary
Addresses the four items raised in CRAN's pre-acceptance review of the 0.4.0 resubmission:
DESCRIPTION. Adds DOI/ISBN-linked citations for the bin-by-bin distance measures (Rubner/Tomasi/Guibas 2000, Swain/Ballard 1991, Puzicha/Hofmann/Buhmann 1997) and average shifted histograms (Scott 2015), in the form CRAN requires (<doi:...>/ISBN:...with no spaces inside the angle brackets).\valuetags in every Rd file. Adds a\valuesection to every exported function listed in the reviewer's note (ash,bindist,binning,ecdfofhist,histogram-message,informationloss,intersect,merge,mergebuckets,message-histogram,plot,plothist,quantiles,scale,subset,trimsparse). Functions that draw on the current device explicitly state "No return value, called for side effects".\dontrun{}cleanup.man/dtrace.Rdno longer needs\dontrun{}— the example now uses the package's bundledinst/extdata/buildkernel-readsize-dtrace.txtsample, so it runs without a live DTrace install.man/informationloss.Rdunwraps thePlotKSDCC/PlotEMDCCcalls; they complete in well under five seconds.HistogramTools.RnwandHistogramTools-quickref.Rnwnow capturepar()andoptions()at the top and restore them at the end, so building the vignettes no longer mutates the caller's graphics parameters or options.Bumps
Versionto0.4.1and records the changes inNEWS.md.Test plan
R CMD build .R CMD check --as-cran HistogramTools_0.4.1.tar.gz— confirm the four reviewer notes are gone (no missing\value, no stray\dontrun{}, references parsed, no "user options changed" diagnostic from the vignettes).?KSDCC,?ReadHistogramsFromDtraceOutputFile,?PlotRelativeFrequencyfor readable\valuetext.