check_file_layout: Check a File's Layout

In cleanr: Helps You to Code Cleaner

Check a File's Layout

Description

Run all file_checks on a file.

Usage

check_file_layout(
  path,
  max_file_length = get_cleanr_options("max_file_length"),
  max_file_width = get_cleanr_options("max_file_width")
)

Arguments

path	Path to the file to be checked.
max_file_length	See check_file_length.
max_file_width	See check_file_width.

Details

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

Value

Invisibly TRUE, but see Details.

See Also

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

Examples

print(cleanr::check_file_layout(system.file("source", "R", "checks.R",
                                            package = "cleanr")))

cleanr documentation built on July 9, 2023, 7:30 p.m.