R documentation with Roxygen?

Question

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.

I have followed Roxygen since the Summer of Code 2008 where it was put together but haven't switched to using it yet either, — Dirk Eddelbuettel, Nov 14 '09 at 15:29

score 16 · Accepted Answer · answered Nov 14 '09 at 18:42

16

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.

answered Nov 14 '09 at 18:42

hadley

98,401
28
176
241

Thanks Hadley! I'm convinced. – Shane Nov 16 '09 at 14:41

score 3 · Answer 2 · answered Nov 15 '09 at 02:43

3

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

answered Nov 15 '09 at 02:43

Peter

1,147
8
20

2

As of 3.0.0., this is no longer true. Roxygen2 completely supports S4, and has budding support for RC. – hadley Mar 23 '14 at 23:01

R documentation with Roxygen?

2 Answers2

Linked