Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Good reference for Roxygen? [closed]

Other than the excellent SO answer here, and the Roxygen manual and vignette, is there any particularly thorough guide to using Roxygen?

like image 956
David LeBauer Avatar asked Dec 24 '10 00:12

David LeBauer


People also ask

What is the R in RD?

also Rd. Rd is a written abbreviation for road. It is used especially in addresses and on maps or signs.

How do I add comments to Roxygen?

Add roxygen2 comments to your . R files. Press Ctrl/Cmd + Shift + D or type devtools::document() to convert roxygen2 comments to . Rd files.

How do I access documents in R?

help operator in R provide access to the documentation pages for R functions, data sets, and other objects, both for packages in the standard R distribution and for contributed packages. To access documentation for the standard lm (linear model) function, for example, enter the command help(lm) or help("lm") , or ?


3 Answers

I'm working on a guide (but it's still incomplete).

A more comprehensive set of vignettes have been added to the package, and were made available on CRAN as of version 4.0.0.

like image 194
hadley Avatar answered Nov 14 '22 00:11

hadley


The user2010 tutorial that was presented by the roxygen authors is available here. It's not really a thorough guide, but still very useful I think.

like image 25
Laurent Avatar answered Nov 14 '22 02:11

Laurent


Even with the refrences above, I still had trouble finding a good kickstarter example until I found this other Github page.

like image 32
D. Woods Avatar answered Nov 14 '22 00:11

D. Woods