Rd2roxygen v1.7

0

Monthly downloads

0th

Percentile

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 that 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.

Readme

Rd2roxygen

Build Status

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

Functions in Rd2roxygen

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

Vignettes of Rd2roxygen

Name
Rd2roxygen.Rmd
No Results!

Last month downloads

Details

Type Package
License GPL
URL https://github.com/yihui/Rd2roxygen
BugReports https://github.com/yihui/Rd2roxygen/issues
VignetteBuilder knitr
RoxygenNote 6.1.0
Encoding UTF-8
NeedsCompilation no
Packaged 2018-08-02 16:26:22 UTC; yihui
Repository CRAN
Date/Publication 2018-08-02 17:00:02 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/Rd2roxygen)](http://www.rdocumentation.org/packages/Rd2roxygen)