Rd2roxygen v1.6.1


Monthly downloads



by Yihui Xie

Convert Rd to Roxygen Documentation

Functions to convert Rd to roxygen documentation. It can parse an Rd file to a list, create the roxygen documentation and update the original R script (e.g. the one containing the definition of the function) accordingly. This package also provides utilities which can help developers build packages using roxygen more easily. The formatR package can be used to reformat the R code in the examples sections so that the code will be more readable.



Build Status

Convert Rd to roxygen documentation. For more information, see http://yihui.name/Rd2roxygen.

Functions in Rd2roxygen

Name Description
reformat_code Format the code in the usage and examples sections
Rd2roxygen Convert all the Rd files of a package to roxygen comments
parse_file Parse the input Rd file to a list
roxygen_and_build Roxygenize a package, clean up and build/check the package
df The df data
parse_and_save Parse the input Rd file and save the roxygen documentation into a file
Rd2roxygen-package Convert Rd to roxygen documentation and utilities to enhance documentation and building packages
create_roxygen Create the roxygen documentation
foo The foo function
bar The bar function
No Results!

Last month downloads


Type Package
Date 2016-04-14
License GPL
URL http://yihui.name/Rd2roxygen
BugReports https://github.com/yihui/Rd2roxygen/issues
VignetteBuilder knitr
RoxygenNote 5.0.1
NeedsCompilation no
Packaged 2016-04-14 21:07:50 UTC; yihui
Repository CRAN
Date/Publication 2016-04-15 08:32:58

Include our badge in your README