Rd2roxygen: 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.

Author
Hadley Wickham [aut], Yihui Xie [aut, cre]
Date of publication
2016-04-15 08:32:58
Maintainer
Yihui Xie <xie@yihui.name>
License
GPL
Version
1.6.1
URLs

View on CRAN

Man pages

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

Files in this package

Rd2roxygen
Rd2roxygen/inst
Rd2roxygen/inst/examples
Rd2roxygen/inst/examples/pkgDemo
Rd2roxygen/inst/examples/pkgDemo/R
Rd2roxygen/inst/examples/pkgDemo/R/foo.R
Rd2roxygen/inst/examples/pkgDemo/R/bar.R
Rd2roxygen/inst/examples/pkgDemo/DESCRIPTION
Rd2roxygen/inst/examples/pkgDemo/man
Rd2roxygen/inst/examples/pkgDemo/man/data.Rd
Rd2roxygen/inst/examples/pkgDemo/man/foo.Rd
Rd2roxygen/inst/examples/pkgDemo/man/bar.Rd
Rd2roxygen/inst/examples/parse_and_save.Rd
Rd2roxygen/inst/examples/reformat_code_demo.Rd
Rd2roxygen/inst/examples/parse_and_save.R
Rd2roxygen/inst/doc
Rd2roxygen/inst/doc/Rd2roxygen.html
Rd2roxygen/inst/doc/Rd2roxygen.R
Rd2roxygen/inst/doc/Rd2roxygen.Rmd
Rd2roxygen/NAMESPACE
Rd2roxygen/NEWS
Rd2roxygen/R
Rd2roxygen/R/rd2roxygen.R
Rd2roxygen/R/utils.R
Rd2roxygen/R/Rd2roxygen-package.R
Rd2roxygen/R/build.R
Rd2roxygen/vignettes
Rd2roxygen/vignettes/Rd2roxygen.Rmd
Rd2roxygen/README.md
Rd2roxygen/MD5
Rd2roxygen/build
Rd2roxygen/build/vignette.rds
Rd2roxygen/DESCRIPTION
Rd2roxygen/man
Rd2roxygen/man/parse_file.Rd
Rd2roxygen/man/roxygen_and_build.Rd
Rd2roxygen/man/Rd2roxygen-package.Rd
Rd2roxygen/man/Rd2roxygen.Rd
Rd2roxygen/man/create_roxygen.Rd
Rd2roxygen/man/parse_and_save.Rd
Rd2roxygen/man/reformat_code.Rd
Rd2roxygen/.Rinstignore