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:Andreas Dominik Cullmann [aut, cre]

cleanr_1.4.0.9000.tar.gz
cleanr_1.4.0.9000.zip(r-4.5)cleanr_1.4.0.9000.zip(r-4.4)cleanr_1.4.0.9000.zip(r-4.3)
cleanr_1.4.0.9000.tgz(r-4.4-any)cleanr_1.4.0.9000.tgz(r-4.3-any)
cleanr_1.4.0.9000.tar.gz(r-4.5-noble)cleanr_1.4.0.9000.tar.gz(r-4.4-noble)
cleanr_1.4.0.9000.tgz(r-4.4-emscripten)cleanr_1.4.0.9000.tgz(r-4.3-emscripten)
cleanr.pdf |cleanr.html
cleanr/json (API)
NEWS

# Install 'cleanr' in R:
install.packages('cleanr', repos = c('https://fvafrcu.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://gitlab.com/fvafrcu/cleanr

On CRAN:

4.22 score 33 scripts 309 downloads 19 exports 17 dependencies

Last updated 1 years agofrom:d994a32fd7. Checks:OK: 7. Indexed: yes.

TargetResultDate
Doc / VignettesOKNov 20 2024
R-4.5-winOKNov 20 2024
R-4.5-linuxOKNov 20 2024
R-4.4-winOKNov 20 2024
R-4.4-macOKNov 20 2024
R-4.3-winOKNov 20 2024
R-4.3-macOKNov 20 2024

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:backportscallrcheckmateclidescfritoolsfsgluelifecyclepkgbuildpkgloadprocessxpsR6rlangrprojrootwithr

An Introduction to cleanr

Rendered fromcleanr_Introduction.Rasciidocusingrasciidoc::rasciidocon Nov 20 2024.

Last update: 2020-11-25
Started: 2020-11-20

Readme and manuals

Help Manual

Help pageTopics
Helps You to Code Cleanercleanr-package
Check a Directorycheck_directory
Check a Filecheck_file
Check a File's Layoutcheck_file_layout
Check a Function's Layoutcheck_function_layout
Check All Functions Defined in a Filecheck_functions_in_file
Check a Packagecheck_package
File Checkscheck_file_length check_file_width file_checks
Function Checkscheck_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