Package: Rd2roxygen 1.16.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:Hadley Wickham [aut], Yihui Xie [aut, cre]

Rd2roxygen_1.16.1.tar.gz
Rd2roxygen_1.16.1.zip(r-4.5)Rd2roxygen_1.16.1.zip(r-4.4)Rd2roxygen_1.16.1.zip(r-4.3)
Rd2roxygen_1.16.1.tgz(r-4.4-any)Rd2roxygen_1.16.1.tgz(r-4.3-any)
Rd2roxygen_1.16.1.tar.gz(r-4.5-noble)Rd2roxygen_1.16.1.tar.gz(r-4.4-noble)
Rd2roxygen_1.16.1.tgz(r-4.4-emscripten)Rd2roxygen_1.16.1.tgz(r-4.3-emscripten)
Rd2roxygen.pdf |Rd2roxygen.html✨
Rd2roxygen/json (API)
NEWS

# 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

On CRAN:

roxygen-documentation

7 exports 32 stars 2.88 score 30 dependencies 1 dependents 1 mentions 786 downloads

Last updated 3 months agofrom:fc87116860

Exports:create_roxygen parse_and_save parse_file rab Rd2roxygen reformat_code roxygen_and_build

Dependencies:brew callr cli commonmark cpp11 desc evaluate formatR fs glue highr knitr lifecycle magrittr pkgbuild pkgload processx ps purrr R6 rlang roxygen2 rprojroot stringi stringr vctrs withr xfun xml2 yaml

Rd2roxygen

Yihui Xie

Rendered fromRd2roxygen.Rmdusingknitr::knitron Jul 24 2024.

Last update: 2024-03-11
Started: 2014-04-01

Citation

Development and contributors

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