Menu
I'm using rogyxen2 template in my R package. As suggested, I added my template R files in a folder called "man-roxygen" in the package directory.
However, when I R CMD check I get the following note:
Non-standard file/directory found at top level: ‘man-roxygen’
Any way to fix this?
Cheers, Philippe
402
To add documentation to an R package, you need to create a subdirectory “ man ” containing a set of files, one per function, in a special R Documentation format ( . Rd ). These will be the source for the documentation for each function; R processes them to create plain text, PDF, and HTML versions.
There are three main ways to run roxygen: roxygen2::roxygenise() . devtools::document() . Ctrl + Shift + D , if you're using RStudio.
R objects are documented in files written in “R documentation” (Rd) format, a simple markup language much of which closely resembles (La)TeX, which can be processed into a variety of formats, including LaTeX, HTML and plain text.
You need to add man-roxygen to the .Rbuildignore file. See the plyr package and how it has done this here. And this post on SO might also be useful.
189
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
