| parse_Rd {tools} | R Documentation |
This function reads an R documentation (Rd) file and parses it, for processing by other functions.
It is experimental.
parse_Rd(file, srcfile = NULL, encoding = "unknown", verbose = FALSE)
file |
A filename or text-mode connection. At present filenames work best. |
srcfile |
NULL, or a "srcfile" object. See the
‘Details’ section. |
encoding |
Encoding to be assumed for input strings. |
verbose |
Logical indicating whether detailed parsing information should be printed. |
This experimental function parses Rd files according to the specification given in http://developer.r-project.org/parseRd.pdf. At the current writing, this is not identical to the rules used by other tools: it is somewhat stricter.
An object of class "Rd". The internal format of this object is
subject to change.
At present files which are marked as Latin-1 or UTF-8 or where
encoding has one of those values result in text marked in the
encoding. In a non-UTF-8 MBCS locale the result will be marked as
UTF-8. In all other cases files are assumed to be in the native encoding.
These functions are still experimental. Names, interfaces and values might change in future versions.
Duncan Murdoch
http://developer.r-project.org/parseRd.pdf
Rd_parse, the function used for parsing
Rd files by R CMD check.
baseRd <- Rd_db("base")
con <- textConnection(baseRd[[1]], "rt")
parse_Rd(con)
close(con)