roxygen2
Using roxygen2 and doxygen on the same package? [closed]
I personally use the following code in a “dataManagement” package I call in all my scripts. It has roxygen documentation and examples. You actually simply call document() and have doxygen ran on the C code, in src/ . The doc is put in inst/doxygen So that your package is CRAN ready. The R documentation being … Read more
Linking to other packages in documentation in roxygen2 in R
You have to type \link[pkg]{function} e.g. \link[stringi]{stri_c}
Error in fetch(key) : lazy-load database
It seems that the error arises when the package cannot be decompressed by R (as @rawr established, it is corrupt). This solutions have worked for me: 1) Check for possible errors in the creation of the .Rdb files 2) Try restarting your R session (e.g. .rs.restartR() if in RStudio) 3) The package might have been … Read more
How to not run an example using roxygen2?
Use \dontrun{} #’@examples #’\dontrun{ #’geocode(“3817 Spruce St, Philadelphia, PA 19104”) #’geocode(“Philadelphia, PA”) #’dat <- data.frame(value=runif(3),address=c(“3817 Spruce St, Philadelphia, PA 19104″,”Philadelphia, PA”,”Neverneverland”)) #’geocode(dat) #’}
How to properly document S4 class slots using Roxygen2?
Updated answer for Roxygen2 5.0.1, current as of 6.0.1 For S4, the best practice now is documenting using the @slot tag: #’ The title for my S4 class that extends \code{“character”} class. #’ #’ Some details about this class and my plans for it in the body. #’ #’ @slot myslot1 A logical keeping track … Read more