Tools to check R code style


[Up] [Top]

Documentation for package ‘lint’ version 0.3

Help Pages

package-lint-package 'lint': R code style checker
assignment-styles Assignment Style
autotest_style Test a patten for consistency.
base-patterns Base Patterns
check_functional function based tests
check_pattern Check a pattern against lines
complex.constant Base Patterns
dispatch_test Dispatch tests to the appropriate handler
exp.constant Base Patterns
find_basic_comment Finder Functions Finders are helper functions that assist in the definition of style checks. These function assist by finding the regions that are either included or excluded from check. Each finder must accept the following arguments and as well as the variadic argument '...'. 1. file 2. lines 3. parse.data Order of arguments is not guaranteed so explicit names use is required, since use of named arguments is guaranteed. In addition other arguments may be added later. Each finder is expected to return a find formated data.frame. Custom finders are encouraged, but finders for common classes are included in the package.
find_call_args Finder Functions Finders are helper functions that assist in the definition of style checks. These function assist by finding the regions that are either included or excluded from check. Each finder must accept the following arguments and as well as the variadic argument '...'. 1. file 2. lines 3. parse.data Order of arguments is not guaranteed so explicit names use is required, since use of named arguments is guaranteed. In addition other arguments may be added later. Each finder is expected to return a find formated data.frame. Custom finders are encouraged, but finders for common classes are included in the package.
find_comment Finder Functions Finders are helper functions that assist in the definition of style checks. These function assist by finding the regions that are either included or excluded from check. Each finder must accept the following arguments and as well as the variadic argument '...'. 1. file 2. lines 3. parse.data Order of arguments is not guaranteed so explicit names use is required, since use of named arguments is guaranteed. In addition other arguments may be added later. Each finder is expected to return a find formated data.frame. Custom finders are encouraged, but finders for common classes are included in the package.
find_doc_comment Finder Functions Finders are helper functions that assist in the definition of style checks. These function assist by finding the regions that are either included or excluded from check. Each finder must accept the following arguments and as well as the variadic argument '...'. 1. file 2. lines 3. parse.data Order of arguments is not guaranteed so explicit names use is required, since use of named arguments is guaranteed. In addition other arguments may be added later. Each finder is expected to return a find formated data.frame. Custom finders are encouraged, but finders for common classes are included in the package.
find_function_args Finder Functions Finders are helper functions that assist in the definition of style checks. These function assist by finding the regions that are either included or excluded from check. Each finder must accept the following arguments and as well as the variadic argument '...'. 1. file 2. lines 3. parse.data Order of arguments is not guaranteed so explicit names use is required, since use of named arguments is guaranteed. In addition other arguments may be added later. Each finder is expected to return a find formated data.frame. Custom finders are encouraged, but finders for common classes are included in the package.
find_function_body Finder Functions Finders are helper functions that assist in the definition of style checks. These function assist by finding the regions that are either included or excluded from check. Each finder must accept the following arguments and as well as the variadic argument '...'. 1. file 2. lines 3. parse.data Order of arguments is not guaranteed so explicit names use is required, since use of named arguments is guaranteed. In addition other arguments may be added later. Each finder is expected to return a find formated data.frame. Custom finders are encouraged, but finders for common classes are included in the package.
find_inside_comment Finder Functions Finders are helper functions that assist in the definition of style checks. These function assist by finding the regions that are either included or excluded from check. Each finder must accept the following arguments and as well as the variadic argument '...'. 1. file 2. lines 3. parse.data Order of arguments is not guaranteed so explicit names use is required, since use of named arguments is guaranteed. In addition other arguments may be added later. Each finder is expected to return a find formated data.frame. Custom finders are encouraged, but finders for common classes are included in the package.
find_number Finder Functions Finders are helper functions that assist in the definition of style checks. These function assist by finding the regions that are either included or excluded from check. Each finder must accept the following arguments and as well as the variadic argument '...'. 1. file 2. lines 3. parse.data Order of arguments is not guaranteed so explicit names use is required, since use of named arguments is guaranteed. In addition other arguments may be added later. Each finder is expected to return a find formated data.frame. Custom finders are encouraged, but finders for common classes are included in the package.
find_string Finder Functions Finders are helper functions that assist in the definition of style checks. These function assist by finding the regions that are either included or excluded from check. Each finder must accept the following arguments and as well as the variadic argument '...'. 1. file 2. lines 3. parse.data Order of arguments is not guaranteed so explicit names use is required, since use of named arguments is guaranteed. In addition other arguments may be added later. Each finder is expected to return a find formated data.frame. Custom finders are encouraged, but finders for common classes are included in the package.
find_symbol Finder Functions Finders are helper functions that assist in the definition of style checks. These function assist by finding the regions that are either included or excluded from check. Each finder must accept the following arguments and as well as the variadic argument '...'. 1. file 2. lines 3. parse.data Order of arguments is not guaranteed so explicit names use is required, since use of named arguments is guaranteed. In addition other arguments may be added later. Each finder is expected to return a find formated data.frame. Custom finders are encouraged, but finders for common classes are included in the package.
following.characters Base Patterns
functional.Rd function based tests
function_style function based tests
int.constant Base Patterns
lint Check for stylistic errors.
lint.style Style checks
make_class_finder Finder Functions Finders are helper functions that assist in the definition of style checks. These function assist by finding the regions that are either included or excluded from check. Each finder must accept the following arguments and as well as the variadic argument '...'. 1. file 2. lines 3. parse.data Order of arguments is not guaranteed so explicit names use is required, since use of named arguments is guaranteed. In addition other arguments may be added later. Each finder is expected to return a find formated data.frame. Custom finders are encouraged, but finders for common classes are included in the package.
name.pattern Base Patterns
numeric.all.constant Base Patterns
numeric.constant Base Patterns
package-lint 'lint': R code style checker
performance-styles Performance Enhancing Styles
performance.square Performance Enhancing Styles
real.constant Base Patterns
spacing.indentation.evenindent Style checks
spacing.indentation.notabs Style checks
spacing.linelength.100 Style checks
spacing.linelength.80 Style checks
spacing.notabs Style checks
spacing.spaceaftercomma Style checks
spacing.spacearoundequals Style checks
spacing.spacearoundinfix Style checks
spacing.twobeforecomments Style checks
start.characters Base Patterns
stylechecks Style checks
styles.assignment.noeq Assignment Style
styles.assignment.norightassign Assignment Style
styles.assignment.notinfcall Assignment Style
style_checks Style checks
style_tests Style checks
test_style Test a patten for consistency.
with_default Look for an argument.