parse_file: Parse the input Rd file to a list
In yihui/Rd2roxygen: Convert Rd to 'Roxygen' Documentation
parse_file R Documentation
Parse the input Rd file to a list
Description
This function uses the function parse_Rd in the tools package to
parse the Rd file.
Usage
parse_file(path)
Arguments
path
the path of the Rd file
Value
a named list containing the documentation sections as strings
Author(s)
Hadley Wickham; modified by Yihui Xie <https://yihui.org>
Examples
rd.file = system.file("examples", "parse_and_save.Rd", package = "Rd2roxygen")
parse_file(rd.file)
yihui/Rd2roxygen documentation built on April 16, 2024, 8:26 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.
| parse_file | R Documentation |
Parse the input Rd file to a list
Description
This function uses the function parse_Rd in the tools package to
parse the Rd file.
Usage
parse_file(path)
Arguments
path |
the path of the Rd file |
Value
a named list containing the documentation sections as strings
Author(s)
Hadley Wickham; modified by Yihui Xie <https://yihui.org>
Examples
rd.file = system.file("examples", "parse_and_save.Rd", package = "Rd2roxygen")
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.