check_directory: Check a Directory

Description Usage Arguments Details Value See Also Examples

View source: R/wrappers.R

Description

Run check_file on files in a directory.

Usage

1
check_directory(path, pattern = "\\.[rR]$", recursive = FALSE, ...)

Arguments

path

Path to the directory to be checked.

pattern

A pattern to search files with, see list.files.

recursive

Search the directory recursively? See list.files.

...

Arguments to be passed to check_file.

Details

The function catches the messages of "cleanr"-conditions thrown by check_file and, if it caught any, throws them.

Value

Invisibly TRUE, but see Details.

See Also

check_package.

Other wrappers: check_file_layout(), check_file(), check_function_layout(), check_functions_in_file(), check_package()

Examples

1
2
3
4
5
6
# load internal functions first.
load_internal_functions("cleanr")
print(cleanr::check_directory(system.file("source", "R", package = "cleanr"),
                              max_num_arguments = 8, max_file_width = 90,
                              max_file_length = 350,
                              check_return = FALSE))

cleanr documentation built on May 12, 2021, 1:07 a.m.