Inspect and update an Rd object or file.
1 2 3 4 5 6 7
an Rd object or file name
name of a package
These functions check if the descriptions of the objects in
are consistent with their current definitions and update them, if
necessary. The details depend on the type of the documented topic.
In general, the functions update entries that can be produced
programmatically, possibly accompanied with a suggestion to the author
to write some additional text.
inspect_Rd checks the
\name section of
dispatches to one of the other
inspect_XXX functions depening
on the type of the topic.
inspect_Rdfun processes documentation of functions. It checks
the usage entries of all functions documented in
updates them if necessary. It appends "
\alias" entries for
functions that do not have them. Entries are created for any arguments
that are missing from the "
\arguments" section. Warning is
given for arguments in the "
\arguments" section that are not
present in at least one usage entry.
the syntax for S3 methods and S4 methods used in "usage" sections, as
inspect_Rdmethods checks and updates documentation of an S4
inspect_Rdclass checks and updates documentation of an S4
Since method signatures and descriptions may be present in
documentation of a class, as well as in that of methods, the question
arises where to put "
\alias" entries to avoid duplication.
Currently, alias entries are put in method descriptions.
Georgi N. Boshnakov