[Rd] Strategies for keeping autogenerated .Rd files out of a Git tree

Kirill Müller kirill.mueller at ivt.baug.ethz.ch
Fri Dec 13 21:53:20 CET 2013


On 12/13/2013 06:09 PM, Brian Diggs wrote:
> One downside I can see with this third approach is that by making the 
> package documentation generation part of the build process, you must 
> then make the package depend/require roxygen (or whatever tools you 
> are using to generate documentation). This dependence, though, is just 
> to build the package, not to actually use the package. And by pushing 
> this dependency onto the end users of the package, you have 
> transferred the problem you mentioned ("... and also binds package 
> development to a specific version of roxygen2 ...") to the many end 
> users rather than the few developers.
That's right. As outlined in another message, roxygen2 would be required 
for building from the "raw" source (hosted on GitHub) but not for 
installing from a source tarball (which would contain the .Rd files). 
Not sure if that's possible, though.



More information about the R-devel mailing list