Rdo_append_argument | R Documentation |
Append an item for a new argument to an Rd object.
Rdo_append_argument(rdo, argname, description = NA, indent = " ", create = FALSE)
rdo |
an Rd object. |
argname |
name of the argument, a character vector. |
description |
description of the argument, a character vector. |
indent |
a string, typically whitespace. |
create |
not used (todo: remove?) |
Appends one or more items to the section describing arguments of functions in an Rd object. The section is created if not present.
If description
is missing or NA, a "todo" text is inserted.
The inserted text is indented using the string indent
.
The lengths of argname
and description
should normally
be equal but if description
is of length one, it is repeated to
achieve this when needed.
an Rd object
Georgi N. Boshnakov
## the following creates Rd object rdo
dummyfun <- function(x) x
fn <- tempfile("dummyfun", fileext = ".Rd")
reprompt(dummyfun, filename = fn)
rdo <- tools::parse_Rd(fn)
## add documentation for arguments
## that are not in the signature of 'dummyfun()'
dottext <- "further arguments to be passed on."
dots <- paste0("\\", "dots")
rdo2 <- Rdo_append_argument(rdo, dots, dottext, create = TRUE)
rdo2 <- Rdo_append_argument(rdo2, "z", "a numeric vector")
## reprompt() warns to remove documentation for non-existing arguments:
Rdo_show(reprompt(rdo2, filename = fn))
unlink(fn)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.