A RoxyTopic is an ordered collection of unique rd_sections
A RoxyTopic object corresponds to a generated .Rd file.
sectionsNamed list of sections. Each item must be an
rd_section() object.
filenamePath to the .Rd file to generate.
format()
Format the .Rd file. It considers the sections in
particular order, even though Rd tools will reorder them again.
RoxyTopic$format(...)
...Passed to the format() methods of the rd_section()
objects, the sections.
Character string.
is_valid()
Check if an .Rd file is valid
RoxyTopic$is_valid()
Logical flag, TRUE for valid .Rd files
has_section()
Check if an .Rd file has a certain section.
RoxyTopic$has_section(type)
typeSection type, a character scalar.
Logical flag.
get_section()
Query a section.
RoxyTopic$get_section(type)
typeSection type, a character scalar.
The rd_section object representing the section, or NULL
if the topic has no such section.
get_value()
Query the value of a section. This is the value of the rd_section object.
RoxyTopic$get_value(type)
typeSection type, a character scalar.
Value.
get_rd()
Get the Rd code of a section.
RoxyTopic$get_rd(type)
typeSection type, a character scalar.
Character vector, one element per line.
get_name()
Get the value of the name section. This is the name
of the Rd topic.
RoxyTopic$get_name()
Character scalar.
inherits_from()
Query the topics this topic inherits type from.
RoxyTopic$inherits_from(type)
typeSection type, a character scalar.
A character vector of topic names.
inherits_section_from()
Query the topics this topic inherits sections from.
RoxyTopic$inherits_section_from()
A character vector of topic names.
add()
Add one or more sections to the topic.
RoxyTopic$add(x, overwrite = FALSE)
xSection(s) to add. It may be
another RoxyTopic object, all of its sections will be added;
or an rd_section object;
or a list of rd_section objects to add.
overwriteWhether to overwrite an existing section. If FALSE
then the two sections will be merged.
add_section()
Add a section.
RoxyTopic$add_section(section, overwrite = FALSE)
sectionrd_section object to add.
overwriteWhether to overwrite an existing section. If FALSE
then the two sections will be merged.
Ensures that each type of name (as given by its name), only appears
once in self$sections. This method if for internal use only.
clone()
The objects of this class are cloneable with this method.
RoxyTopic$clone(deep = FALSE)
deepWhether to make a deep clone.
Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.