Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

R documentation with Roxygen? [closed]

I find R documentation to be important but also time-consuming to create/maintain. Has anyone used Roxygen yet, and if so, does it help in maintaining an R package? I've used Doxygen in the past, but those projects didn't have the man structure that R packages require.

You can find the vignette here.

like image 858
Shane Avatar asked Nov 14 '09 15:11

Shane


2 Answers

Yes, I use it all the time (in five packages and counting). It's fantastic! With it I managed to create a complete R package (stringr) in about five hours.

I recently submitted a patch to get a 10-fold speed up, which makes it even nicer to use.

like image 71
hadley Avatar answered Oct 19 '22 19:10

hadley


I'd like to start using it, but as far as I know it doesn't yet support S4 classes, which I use extensively.

like image 29
Peter Avatar answered Oct 19 '22 21:10

Peter