findMissingRdSections: Find Missing Sections in Rd Files

In FastUtils: Fast, Readable Utility Functions

Find Missing Sections in Rd Files

Description

This function scans Rd documentation files in the specified package's ⁠\man⁠ directory to identify which functions lack certain documentation sections like ⁠\examples⁠. If there are no missing sections in all the Rd files, then the output is a character(0)

Usage

findMissingRdSections(
  sectionName,
  pkg = ".",
  ignore = NULL,
  .ignore = "-package$"
)

fmrs(sectionName, pkg = ".", ignore = NULL, .ignore = "-package$")

Arguments

sectionName	A character vector of the Rd sections to look for.
pkg	The path to the package directory, defaulting to the current directory.
ignore	Additional Regexes of function names to be ignored in the output.
.ignore	More regexes of functions to ignore set by default. Will be appended with the ignore regexes and unioned with joinRegex().

Value

Character vector of function names that are missing any of the specified sections in their Rd files. May be length 0 if all fulfill criteria.

Examples

try(
  findMissingRdSections(c("examples", "example"), pkg = "."),
  silent = TRUE
)

FastUtils documentation built on Sept. 11, 2024, 5:13 p.m.