The Intro to the Intro | A first example | Options | Checking for File Layout | Checking for Function Layout | Checking for File and Function Layout | Disabling checks | References
Package: cleanr 1.4.0.9000
cleanr: Helps You to Code Cleaner
Check your R code for some of the most common layout flaws. Many tried to teach us how to write code less dreadful, be it implicitly as B. W. Kernighan and D. M. Ritchie (1988) <ISBN:0-13-110362-8> in 'The C Programming Language' did, be it explicitly as R.C. Martin (2008) <ISBN:0-13-235088-2> in 'Clean Code: A Handbook of Agile Software Craftsmanship' did. So we should check our code for files too long or wide, functions with too many lines, too wide lines, too many arguments or too many levels of nesting. Note: This is not a static code analyzer like pylint or the like. Checkout <https://cran.r-project.org/package=lintr> instead.
Authors:
cleanr_1.4.0.9000.tar.gz
cleanr_1.4.0.9000.zip(r-4.7-any)cleanr_1.4.0.9000.zip(r-4.6-any)cleanr_1.4.0.9000.zip(r-4.5-any)
cleanr_1.4.0.9000.tgz(r-4.6-any)cleanr_1.4.0.9000.tgz(r-4.5-any)
cleanr_1.4.0.9000.tar.gz(r-4.7-any)cleanr_1.4.0.9000.tar.gz(r-4.6-any)
cleanr_1.4.0.9000.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
cleanr/json (API)
| # Install 'cleanr' in R: |
| install.packages('cleanr', repos = c('https://fvafrcu.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://gitlab.com/fvafrcu/cleanr
Last updated from:d994a32fd7. Checks:9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel | OK | 191 | ||
| source / vignettes | OK | 173 | ||
| linux-release | OK | 190 | ||
| macos-release | OK | 118 | ||
| macos-oldrel | OK | 78 | ||
| windows-devel | OK | 80 | ||
| windows-release | OK | 90 | ||
| windows-oldrel | OK | 76 | ||
| wasm-release | OK | 124 |
Exports:check_directorycheck_filecheck_file_layoutcheck_file_lengthcheck_file_widthcheck_function_layoutcheck_functions_in_filecheck_line_widthcheck_nesting_depthcheck_num_argumentscheck_num_linescheck_num_lines_of_codecheck_packagecheck_returngcoget_cleanr_optionsis_not_falseload_internal_functionsset_cleanr_options
Dependencies:backportscallrcheckmateclidescfritoolsfsgluelifecycleotelpkgbuildpkgloadprocessxpsR6rlangrprojroot
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Helps You to Code Cleaner | cleanr-package |
| Check a Directory | check_directory |
| Check a File | check_file |
| Check a File's Layout | check_file_layout |
| Check a Function's Layout | check_function_layout |
| Check All Functions Defined in a File | check_functions_in_file |
| Check a Package | check_package |
| File Checks | check_file_length check_file_width file_checks |
| Function Checks | check_line_width check_nesting_depth check_num_arguments check_num_lines check_num_lines_of_code check_return function_checks |
| Get options for 'cleanr' | gco get_cleanr_options |
| Set Options for 'cleanr' | set_cleanr_options |