Roxygen is an in-source documentation system for R. It is based on Doxygen, and is an alternative to creating .Rd files, in that it automatically creates the package's .Rd files from the in-source documentation.
Roxygen is an in-source documentation system for R. It is based on Doxygen, and is an alternative to creating .Rd files, in that it automatically creates the package's .Rd files from the in-source documentation.
The first sentence of any Roxygen block briefly describes its object; and may be followed directly by a Roxygen tag or a more detailed description .
The detailed description begins after the intervening blank line, and continues until the first Roxygen tag .
Each Roxygen tag begins with an ampersand, like @name, @author, etc.; which means, incidentally, that all real ampersands have to be escaped with a double-ampersand.
Availability
Roxigen was hosted on http://roxygen.org/ until 2018. See it on the Wayback Machine at https://web.archive.org/web/20180809105527/http://roxygen.org/.
