Diagnose Bare Calls to Unexported Functions in Examples — lab_unexported_example

Flags an \examples{} block that calls its own topic bare when that topic is not exported. Examples run with only the package's exports attached, so the call fails.

Usage

lab_unexported_example_ns(path = ".", verbose = TRUE)

Arguments

path: Character. Path to package directory
verbose: Logical. Print diagnostic messages

Value

checktor_check_result() with passed, issues, message.

Details

R CMD check does catch this, but only by RUNNING the examples, which is late and slow, and it is skipped entirely when examples are wrapped in \dontrun{} or when you check with --no-examples. This finds it statically in a second.

Source

No formal rule. An example that reaches for an unexported object will error when it runs, which is why this sits at robustness tier. See vignette("check-sources", package = "checktor") for how every check maps to its source.

Examples

pkg <- example_diagnose_scenario("documentation_examples/unexported_example_ns_bad.Rd",
                                 show_content = FALSE)
# The package exports something, but not internal_values()
writeLines("export(public_values)", file.path(pkg, "NAMESPACE"))
lab_unexported_example_ns(pkg, verbose = FALSE)$issues
#> [1] "unexported_example_ns_bad.Rd: example calls unexported 'internal_values()', so it fails when the example runs"
unlink(pkg, recursive = TRUE)