check_function_layout

object

The name to be used for reporting. If NULL, it is
substituted from the object given. Argument is mainly there to pass name for
functions retrieved via <code><a rd-options="" href="/link/get?package=cleanr&version=1.1.3" data-mini-rdoc="cleanr::get">get</a></code> in the wrapper function
<code><a rd-options="" href="/link/check_functions_in_file?package=cleanr&version=1.1.3" data-mini-rdoc="cleanr::check_functions_in_file">check_functions_in_file</a></code>.

function_name

See <code><a rd-options="" href="/link/check_num_lines_of_code?package=cleanr&version=1.1.3" data-mini-rdoc="cleanr::check_num_lines_of_code">check_num_lines_of_code</a></code>.

max_lines_of_code

See <code><a rd-options="" href="/link/check_num_lines?package=cleanr&version=1.1.3" data-mini-rdoc="cleanr::check_num_lines">check_num_lines</a></code>.

max_lines

See <code><a rd-options="" href="/link/check_num_arguments?package=cleanr&version=1.1.3" data-mini-rdoc="cleanr::check_num_arguments">check_num_arguments</a></code>.

max_num_arguments

See <code><a rd-options="" href="/link/check_nesting_depth?package=cleanr&version=1.1.3" data-mini-rdoc="cleanr::check_nesting_depth">check_nesting_depth</a></code>.

max_nesting_depth

See <code><a rd-options="" href="/link/check_line_width?package=cleanr&version=1.1.3" data-mini-rdoc="cleanr::check_line_width">check_line_width</a></code>.

max_line_width

See <code><a rd-options="" href="/link/check_return?package=cleanr&version=1.1.3" data-mini-rdoc="cleanr::check_return">check_return</a></code>.

check_return


Run all <code><a rd-options="" href="/link/function_checks?package=cleanr&version=1.1.3" data-mini-rdoc="cleanr::function_checks">function_checks</a></code> on a function.


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://github.com/jimhester/lintr instead.

Andreas Dominik Cullmann

cleanr

Helps You to Code Cleaner

check_function_layout function

The name to be used for reporting. If NULL, it is
substituted from the object given. Argument is mainly there to pass name for
functions retrieved via <code><a rd-options='' href='get'>get</a></code> in the wrapper function
<code><a rd-options='' href='check_functions_in_file'>check_functions_in_file</a></code>.

See <code><a rd-options='' href='check_num_lines_of_code'>check_num_lines_of_code</a></code>.

See <code><a rd-options='' href='check_num_lines'>check_num_lines</a></code>.

See <code><a rd-options='' href='check_num_arguments'>check_num_arguments</a></code>.

See <code><a rd-options='' href='check_nesting_depth'>check_nesting_depth</a></code>.

See <code><a rd-options='' href='check_line_width'>check_line_width</a></code>.

See <code><a rd-options='' href='check_return'>check_return</a></code>.


Run all <code><a rd-options='' href='function_checks'>function_checks</a></code> on a function.


check_function_layout: Check a Function's Layout

Description

Usage

Arguments

Value

Details

Examples