R documentation with Roxygen?

1.4k Views Asked by At

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.

2

There are 2 best solutions below

1
On BEST ANSWER

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.

1
On

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