Rd2roxygen: Convert Rd to roxygen documentation | /en/2010/12/rd2roxygen-convert-rd-to-roxygen-documentation/

yihui 2022-12-16 19:38:32

Rd2roxygen: Convert Rd to roxygen documentation

https://yihui.org/en/2010/12/rd2roxygen-convert-rd-to-roxygen-documentation/

4 Comments

giscus-bot 2022-12-16 19:38:33

Guest *Nan Xiao* @ 2010-12-03 04:40:28 originally posted:

Python users r luckier for they have 'Excalibur(s)' called 'pydoc' and 'Epydoc' for automatically generating docs, and 'Sphinx', an even more powerful tool for hand-writing docs ... Maybe that's exactly what we want?

@nanxstats

yihui 2022-12-16 19:38:37

I don't know pydoc; I heard about javadoc before, which is somehow similar to the idea of Doxygen (inline documentation with the functions), and roxygen borrowed the idea from Doxygen. So now it is not really a big trouble to write R documentation in roxygen; roxygen can convert R comments into R documentation. What I wanted was to go back from R doc to roxygen comments, so that I can continue to develop my packages easily.

Originally posted on 2010-12-03 08:42:19

giscus-bot 2022-12-16 19:38:34

Guest *Nan Xiao* @ 2010-12-03 09:02:26 originally posted:

I see. R should have had a better doc writing mechanism(low-level support, without high level hack), really wish R&R to consider this in their next language ...

@nanxstats

yihui 2022-12-16 19:38:37

Unfortunately the roxygen package has almost stopped its development after the Google Summer of Code in 2008. There are a lot of places to improve in this package. Let's wait and see if there will be any progress next summer; I know some people want to hire this author to continue working on this package.

Originally posted on 2010-12-03 09:14:34

giscus-bot 2022-12-16 19:38:38

Guest *Nan Xiao* @ 2010-12-03 10:29:13 originally posted:

Yep, it seems promising ..
"Work hard to be lazy" .. so how lazy you are? hahaha

@nanxstats

yihui 2022-12-16 19:38:39

My laziness might be beyond your imagination. I said I din't even bother to type ##' by hand, and I'm happy that Emacs+ESS can add this comment prefix automatically. I'm lazy to do the non-technical and tedious things.

Originally posted on 2010-12-03 19:48:17

giscus-bot 2022-12-16 19:38:35

Guest *David Rosenberg* @ 2010-12-22 02:08:28 originally posted:

If you just want an easy way to maintain package documentation, but don't particularly care about oxygen documentation, definitely give the inlinedocs package a look. http://inlinedocs.r-forge.r-project.org/
I've been using it for a while and highly recommend it.

giscus-bot 2022-12-16 19:38:36

Guest *David Rosenberg* @ 2010-12-22 02:44:29 originally posted:

This worked great for me with LyX 1.6, but I'm having trouble getting it working with LyX 2.0 Beta. I changed the install script in one place to find my LyX 2.0 preferences file, and it did modify it. But when running, I get "An error occurred while running: R -e "options(encoding='UTF-8');library(pgfSweave);..." Does anything else need to change that you know of?
Thanks! The installer script is very convenient!

yihui 2022-12-16 19:38:40

You really want to reply on the previous post (http://yihui.name/en/2010/10/how-to-start-using-pgfsweave-in-lyx-in-one-minute/), don't you? And it seems you are using an old configuration script (I've changed the way to call R; it is no longer like R -e "options(encoding=’UTF-8′);library(pgfSweave)..."; see the previous post.)

I will wait for the final release of LyX 2.0 -- I don't want to do anything on the beta version. LyX 2.0 has built-in support for Sweave; basically I think you can modify the R script under a certain system directory of LyX (I don't remember exactly).

Originally posted on 2010-12-22 02:56:23

giscus-bot 2022-12-16 19:38:41

Guest *David Rosenberg* @ 2010-12-22 04:21:18 originally posted:

Thanks -- I guess I'll wait for the release of 2.0 as well. And sorry for replying to the wrong posting. I was still setup from my reply about inlinedocs.