releaser (version 1.2.1)

check_docs: Check R package documentation

Description

Performs a series of documentation consistency checks on a package using roxygen2 parsed blocks.

The following checks are performed:

• Missing @examples tag in exported functions

• Missing example content

• Missing @title

• Usage of discouraged @describeIn

• Usage of deprecated @return

• Missing @returns

Usage

check_docs(pkg_dir = ".", verbose = interactive(), error_on_fail = FALSE)

Value

An object of class "releaser_doc_check" containing a named list of detected issues.

Arguments

pkg_dir

Path to the R package.

verbose

Logical. If TRUE, prints a formatted summary.

error_on_fail

Logical. If TRUE, stops execution if any issue is found.

Examples

if (FALSE) {
my_pkg_dir <- "path/to/my/package"

# Full check
results <- check_docs(my_pkg_dir)
}