Roxygen

Literate programming in R

• What is Roxygen?
  • Documentation
• Downloading Roxygen
• Support for Roxygen
  • StatET
  • ESS
• Contact

What is Roxygen?

Roxygen is a Doxygen-like documentation system for R; allowing in-source specification of Rd files, collation and namespace directives.

Documentation

To get started with Roxygen, see our vignette; or manual for a detailed outlay of individual functions.

For historical interest, our GSoC proposal is available (nota bene: design decisions have changed).

Downloading Roxygen

Roxygen is available on CRAN; issue the following from within R to install it:

install.packages("roxygen")

You can also check out a pre-release version from our repository at R-Forge.

Support for Roxygen

StatET

StatET 0.7.0 and above fully supports Roxygen; featured are:

• syntax-highlighting,
• R CMD roxygen integration,
• links to @example files,
• automatic comment templates,
• autocompletion of Roxygen tags (Content Assist).

ESS

ESS partially supports Roxygen. Issuing (require 'ess-roxygen) provides ess-roxygen-fn which, when invoked from within a function, automatically adds @param and @return tags.

Indentation works, but filling and highlighting are “not currently planned,” according to Stephen Eglen; if you'd like to see ESS support Roxygen, please send a message to ESS-help.

Contact

Someone's usually lurking on #roxygen at Freenode; or you can try our mailing lists.