function_argument_linter {lintr} | R Documentation |
Function argument linter
Description
Check that arguments with defaults come last in all function declarations, as per the tidyverse design guide.
Changing the argument order can be a breaking change. An alternative to changing the argument order
is to instead set the default for such arguments to NULL
.
Usage
function_argument_linter()
Tags
best_practices, consistency, style
See Also
-
linters for a complete list of linters available in lintr.
Examples
# will produce lints
lint(
text = "function(y = 1, z = 2, x) {}",
linters = function_argument_linter()
)
lint(
text = "function(x, y, z = 1, ..., w) {}",
linters = function_argument_linter()
)
# okay
lint(
text = "function(x, y = 1, z = 2) {}",
linters = function_argument_linter()
)
lint(
text = "function(x, y, w, z = 1, ...) {}",
linters = function_argument_linter()
)
lint(
text = "function(y = 1, z = 2, x = NULL) {}",
linters = function_argument_linter()
)
lint(
text = "function(x, y, z = 1, ..., w = NULL) {}",
linters = function_argument_linter()
)
[Package lintr version 3.1.2 Index]