check_codetags {packager} | R Documentation |
Check for Code Tags
Description
You do use code tags (see PEP 350 for example)? This function searches for files under a directory containing such tags.
Usage
check_codetags(
path = ".",
exclude_pattern = "\\.Rcheck/",
include_pattern = "\\.[Rr]$|\\.[Rr]md$",
pattern = "XXX:|FIXME:|TODO:"
)
Arguments
path |
to a directory, typically a package root. |
exclude_pattern |
A pattern for exclusions based on the file names.
Stronger than |
include_pattern |
A pattern for inclusions based on the file names. |
pattern |
The pattern to search for. |
Value
A character vector of hits.
See Also
Other maintenance functions:
check_archive()
,
check_cyclomatic_complexity()
,
check_news()
,
check_usage()
,
get_check_status()
Examples
dir <- system.file("runit_tests", package = "packager")
r <- check_codetags(dir)
print(r)
[Package packager version 1.15.2 Index]