cleanr

Check your R code for some of the most common layout flaws.

Introduction

Please read the vignette.

Or, after installation, the help page:

help("cleanr-package", package = "cleanr")

#> Helps You to Code Cleaner
#> 
#> Description:
#> 
#>      Check your R code for some of the most common layout flaws.
#> 
#> Details:
#> 
#>      Many tried to teach us how to write code less dreadful, be it
#>      implicitly as B. W. Kernighan and D. M. Ritchie in The C
#>      Programming Language did, be it explicitly as R.C. Martin 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. If
#>      you're looking for a static code analyzer, check out lintr (<URL:
#>      https://cran.r-project.org/package=lintr> or <URL:
#>      https://github.com/jimhester/lintr>).
#> 
#> See Also:
#> 
#>      Packages 'codetools' (<URL:
#>      https://cran.r-project.org/package=codetools>), 'formatR' (<URL:
#>      https://cran.r-project.org/package=formatR>) and 'lintr' (<URL:
#>      https://cran.r-project.org/package=lintr>).

Installation

You can install cleanr from gitlab via:

if (! require("remotes")) install.packages("remotes")
remotes::install_gitlab("fvafrCU/cleanr")