Convert a whole package | Parse a single Rd file | Roxygenize and build a package
Package: Rd2roxygen 1.18.1
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 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.
Authors:
Rd2roxygen_1.18.1.tar.gz
Rd2roxygen_1.18.1.zip(r-4.7)Rd2roxygen_1.18.1.zip(r-4.6)Rd2roxygen_1.18.1.zip(r-4.5)
Rd2roxygen_1.18.1.tgz(r-4.6-any)Rd2roxygen_1.18.1.tgz(r-4.5-any)
Rd2roxygen_1.18.1.tar.gz(r-4.7-any)Rd2roxygen_1.18.1.tar.gz(r-4.6-any)
Rd2roxygen_1.18.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
Rd2roxygen/json (API)
| # Install 'Rd2roxygen' in R: |
| install.packages('Rd2roxygen', repos = c('https://yihui.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/yihui/rd2roxygen/issues
Last updated from:d2d22b4052. Checks:9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel-x86_64 | OK | 115 | ||
| source / vignettes | OK | 179 | ||
| linux-release-x86_64 | OK | 100 | ||
| macos-release-arm64 | OK | 89 | ||
| macos-oldrel-arm64 | OK | 111 | ||
| windows-devel | OK | 61 | ||
| windows-release | OK | 67 | ||
| windows-oldrel | OK | 66 | ||
| wasm-release | OK | 112 |
Exports:create_roxygenparse_and_saveparse_filerabRd2roxygenreformat_coderoxygen_and_build
Dependencies:brewcallrclicommonmarkcpp11descevaluateformatRfsgluehighrknitrlifecycleotelpkgbuildpkgloadprocessxpsR6rlangroxygen2rprojrootwithrxfunxml2yaml
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Convert Rd to roxygen documentation and utilities to enhance documentation and building packages | Rd2roxygen-package |
| Create the roxygen documentation | create_roxygen |
| Parse the input Rd file and save the roxygen documentation into a file | parse_and_save |
| Parse the input Rd file to a list | parse_file |
| Convert all the Rd files of a package to roxygen comments | Rd2roxygen |
| Format the code in the usage and examples sections | reformat_code |
| Roxygenize a package, clean up and build/check the package | rab roxygen_and_build |
