search

VisionEval / VisionEval-Dev

Development version of VisionEval framework
https://visioneval.github.io/
Apache License 2.0
6 stars 32 forks source link

Fix NAMESPACE generation in packages #48

Closed jrawbits closed 4 years ago

jrawbits commented 5 years ago

Currently, some of the package NAMESPACE files claim to be auto-generated by Roxygen with a warning not to hand edit. In fact, there is no documented build step to generate the namespace, and if one does use Roxygen, the @ exports are not properly generated. So the NAMESPACE cannot be built by Roxygen and in fact, doing so will overwrite precious information (the exports).

I've observed this problem with VEScenario, but it may occur other places. The imports and exports should be fully and completely identified in the Roxygen documentation comments.

For package build purposes, NAMESPACE (once we know it can be correctly rebuilt) should be removed from the Github code tree (and .gitignore'd), and VE Installer should be updated to run the devtools::document() step (to rebuild, at a minimum, the NAMESPACE) prior to building the source package.

jrawbits commented 4 years ago

Closing this issues, since NAMESPACE and other built artifacts (the data/ directory in particular) are versioned in Github. I'll start another issue on the Github structure. Roxygen is used to create the NAMESPACE based on source code comments. This is done during package delivery. Recommend removing such built artifacts from the Github since they are easily recreated by RStudio's package build process (or by VE-Installer).