create_roxygen: Create the roxygen documentation
In Rd2roxygen: Convert Rd to 'Roxygen' Documentation
create_roxygen R Documentation
Create the roxygen documentation
Description
The parsed information is converted to a vector of roxygen tags.
Usage
create_roxygen(info, usage = FALSE)
Arguments
info
the named list of the parsed documentation
usage
logical: whether to include the usage section in the output
(this can be useful when there are multiple functions in a single usage
section, but generally it is not necessary because roxygen can generate the
usage section automatically)
Value
a character vector
Author(s)
Hadley Wickham; modified by Yihui Xie <http://yihui.org>
Examples
rd.file = system.file("examples", "parse_and_save.Rd", package = "Rd2roxygen")
options(roxygen.comment = "##' ")
create_roxygen(parse_file(rd.file))
Rd2roxygen documentation built on Aug. 10, 2022, 1:09 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| create_roxygen | R Documentation |
Create the roxygen documentation
Description
The parsed information is converted to a vector of roxygen tags.
Usage
create_roxygen(info, usage = FALSE)
Arguments
info |
the named list of the parsed documentation |
usage |
logical: whether to include the usage section in the output (this can be useful when there are multiple functions in a single usage section, but generally it is not necessary because roxygen can generate the usage section automatically) |
Value
a character vector
Author(s)
Hadley Wickham; modified by Yihui Xie <http://yihui.org>
Examples
rd.file = system.file("examples", "parse_and_save.Rd", package = "Rd2roxygen")
options(roxygen.comment = "##' ")
create_roxygen(parse_file(rd.file))
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.