Rdo_set_section | R Documentation |
Replace a section in an Rd file.
Rdo_set_section(text, sec, file, ...)
text |
the new text of the section, a character vector. |
sec |
name of the section. |
file |
name of the file. |
... |
arguments to be passed on to |
Parses the file, replaces the specified section with the new content
and writes the file back. The text is processed as appropriate for the
particular section (sec
).
For example:
Rdo_set_section("Georgi N. Boshnakov", "author", "./man/Rdo2Rdf.Rd")
(Some care is needed with the author field for "xxx-package.Rd" files, such
as "Rdpack-package.Rd", where the Author(s)
field has
somewhat different layout.)
By default Rdo_set_section
does not create the section if it
does not exist, since this may not be desirable for some Rd files. The
"..." arguments can be used to change this, they are passed on to
Rdo_modify
, see its documentation for details.
This function is used mainly for the side effect of changing file
.
It returns the Rd formatted text as a character vector.
Georgi N. Boshnakov
Rdo_modify
fnA <- tempfile("dummyfun", fileext = "Rd")
dummyfun <- function(x) x
reprompt(dummyfun, filename = fnA)
Rdo_show(tools::parse_Rd(fnA))
## set the author section, create it if necessary.
Rdo_set_section("A.A. Author", "author", fnA, create = TRUE)
Rdo_show(tools::parse_Rd(fnA))
## replace the author section
Rdo_set_section("Georgi N. Boshnakov", "author", fnA)
Rdo_show(tools::parse_Rd(fnA))
unlink(fnA)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.