search

nevrome / bleiglas

R Package - Spatiotemporal Data Interpolation and Visualisation based on 3D Tessellation
MIT License
14 stars 1 forks source link

package dependencies in scripts referenced by the vignette #14

Closed corybrunson closed 3 years ago

corybrunson commented 3 years ago

The vignette refers to, but does not evaluate, scripts installed in "inst/workflow_example", which seem to depend not only on the rnaturalearth package but also on packages including rgdal that are required by specific steps. I'm not sure what the exact protocol is for such a setup (unless i've missed something, the R extensions manual is silent on this), but should these packages at least be listed as dependencies (presumably under Suggests:) in DESCRIPTION? This is indeed a question, not a recommendation, since the vignette can be generated (and bleiglas can be installed) without installing these.

Part of this JOSS review.

nevrome commented 3 years ago

The setup is indeed unusual. Probably the Quickstart guide in the README would be more typical for a vignette. But then again vignettes are used for many different purposes (some times even whole research papers) and I think this extensive compilation of commented code could be useful for someone who really wants to use this package to the fullest.

I would rather not have the heavy dependencies for this specific case study in the package DESCRIPTION though. Instead I added explicit installation instructions at the beginning of the vignette in 8855d24. Do you think this makes it reasonably accessible?

corybrunson commented 3 years ago

Do you mean fb65fad3952ed3d9c8e387671258e1aa00527352? This looks good to me.

nevrome commented 3 years ago

Ah - yes - right. I must have copied the wrong hash. Thanks for searching yourself!