Rdo_get_item_labels | R Documentation |
Get the labels of items in an Rd object.
Rdo_get_item_labels(rdo)
rdo |
an Rd object. |
Rdo_get_item_labels(rdo)
gives the labels of all
"\item"
s in rdo
. Argument rdo
is often a section
or other Rd object fragment, see the examples.
a character vector
Georgi N. Boshnakov
infile <- system.file("examples", "tz.Rd", package = "Rdpack")
rd <- tools::parse_Rd(infile)
## get item labels found anywhere in the Rd object
(items <- Rdo_get_item_labels(rd))
## search only in section "arguments" (i.e., get argument names)
## (note [[1]] - there is only one arguments section)
pos.args <- Rdo_locate_core_section(rd, "\\arguments")[[1]]
(args <- Rdo_get_item_labels(rd[[pos.args$pos]]))
## search only in section "value"
pos.val <- Rdo_locate_core_section(rd, "\\value")[[1]]
(vals <- Rdo_get_item_labels(rd[[pos.val$pos]]))
## There are no other items in 'rd', so this gives TRUE:
all.equal(items, c(args, vals)) # TRUE
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.