-
Notifications
You must be signed in to change notification settings - Fork 240
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
updated priors vignette so that it works, exported required functions #2439
Conversation
Co-Authored-By: Chris Black <chris@ckblack.org>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dlebauer Overall this looks great. Thanks for getting it working again!
To get Travis tests passing, I think it should suffice to add MASS
to the Imports section of the DESCRIPTION file. (Note that the check failure is only detecting the undeclared import, not running the vignette code -- making Travis actually build vignettes is a separate issue discussed in #2437).
Once tests pass, I'm happy to merge this, but a longer-term consideration that can wait for a different PR: This vignette uses a lot of external packages that aren't currently listed as dependencies for the Priors package -- I see at least dplyr, DEoptim, fitdistrplus, rjags, rriskDistributions. These need to be declared as package dependencies, so we should (1) consider whether they add enough to the vignette to be worth the installation footprint or whether we can show usage effectively without them, then (2) remove any we can live without and (3) declare the rest in Suggests.
No idea! I think I just used devtools::document()
… --
_______________________
*David LeBauer*
Director of Data Sciences
Arizona Experiment Station
THE UNIVERSITY OF ARIZONA
Bioscience Research Labs, 207
1230 N Cherry Ave | Tucson, AZ 85721
Office: 520-621-4381
dlebauer@email.arizona.edu
orcid <https://orcid.org/0000-0001-7228-053X> | twitter
<https://twitter.com/dlebauer> | github <https://github.com/dlebauer> |
linkedin <https://www.linkedin.com/in/dlebauer/>
|
@dlebauer Huh, weird. Well, I'd say fix the missing MASS declaration and see if the build passes -- if it does, the problem was on my end. If it complains about files changing during the build, then we'll need to revisit this |
@infotroph I've added MASS to imports regarding the dependencies ... I think fitdistrplus, rjags, and rriskDistributions are critical to the vignette - since the vignette shows how to use these packages to come up with priors. DEoptim could possibly be replaced with optim and dplyr could certainly be replaced. But then this brings up the question of whether it is worthwhile to refactor code just to reduce dependencies (especially in vignettes, or in the case of dplyr, where the package is installed elsewhere in the PEcAn build). |
somehow this keeps R from confusing these with S3 methods ...
* remove unneeded Roxygen tags, keep documentation aliases to old names * change references elsewhere * remove s3 inconsistency warning from cached check results * fix easy check errors in renamed functions, add harder ones to cached checks list * changelog * update depends
Thanks for your help @infotroph! Finally can merge! |
Updated the prior vignette so that it can compile. This required exporting a few functions from the PEcAn.priors function. Or perhaps these were incorrectly identified as S3 methods.
Motivation and Context
To get the vignette working again.
Review Time Estimate
Types of changes
Checklist: