find_missing_tags: Find missing 'return' tag when function exported

In ThinkR-open/checkhelper: Deal with Check Outputs

Find missing 'return' tag when function exported

Description

Find missing 'return' tag when function exported

Usage

find_missing_tags(
  package.dir = ".",
  roclets = NULL,
  load_code = NULL,
  clean = FALSE
)

Arguments

package.dir	Location of package top level directory. Default is working directory.
roclets	Character vector of roclet names to use with package. The default, NULL, uses the roxygen roclets option, which defaults to c("collate", "namespace", "rd").
load_code	A function used to load all the R code in the package directory. The default, NULL, uses the strategy defined by the load roxygen option, which defaults to load_pkgload(). See load for more details.
clean	If TRUE, roxygen will delete all files previously created by roxygen before running each roclet.

Value

a list with the 3 data.frames with the missing tags

Examples

## Not run: 
# What you will do from inside your package
find_missing_tags()

## End(Not run)
# A reproducible example on a test package
pkg_path <- create_example_pkg()
find_missing_tags(pkg_path)

ThinkR-open/checkhelper documentation built on Jan. 26, 2024, 4:16 p.m.