Skip to contents

Assignment linter

Source: R/assignment_linter.R
assignment_linter.Rd

Check that the specified operator is used for assignment.

Usage

assignment_linter(
  operator = c("<-", "<<-"),
  allow_cascading_assign = TRUE,
  allow_right_assign = FALSE,
  allow_trailing = TRUE,
  allow_pipe_assign = FALSE
)

Arguments

operator

Character vector of valid assignment operators. Defaults to allowing <- and <<-; other valid options are =, ->, ->>, %<>%; use "any" to denote "allow all operators", in which case this linter only considers allow_trailing for generating lints.

allow_cascading_assign

(Deprecated) Logical, default TRUE. If FALSE, <<- and ->> are not allowed.

allow_right_assign

(Deprecated) Logical, default FALSE. If TRUE, -> and ->> are allowed.

allow_trailing

Logical, default TRUE. If FALSE then assignments aren't allowed at end of lines.

allow_pipe_assign

(Deprecated) Logical, default FALSE. If TRUE, magrittr's %<>% assignment is allowed.

See also

Tags

configurable, consistency, default, style

Examples

# will produce lints
lint(
  text = "x = mean(x)",
  linters = assignment_linter()
)
#> <text>:1:3: style: [assignment_linter] Use one of <-, <<- for assignment, not =.
#> x = mean(x)
#>   ^

code_lines <- "1 -> x\n2 ->> y"
writeLines(code_lines)
#> 1 -> x
#> 2 ->> y
lint(
  text = code_lines,
  linters = assignment_linter()
)
#> <text>:1:3: style: [assignment_linter] Use one of <-, <<- for assignment, not ->.
#> 1 -> x
#>   ^~
#> <text>:2:3: style: [assignment_linter] Use one of <-, <<- for assignment, not ->>.
#> 2 ->> y
#>   ^~~

lint(
  text = "x %<>% as.character()",
  linters = assignment_linter()
)
#> <text>:1:3: style: [assignment_linter] Avoid the assignment pipe %<>%; prefer pipes and assignment in separate steps.
#> x %<>% as.character()
#>   ^~~~

lint(
  text = "x <- 1",
  linters = assignment_linter(operator = "=")
)
#> <text>:1:3: style: [assignment_linter] Use = for assignment, not <-.
#> x <- 1
#>   ^~

# okay
lint(
  text = "x <- mean(x)",
  linters = assignment_linter()
)
#> ℹ No lints found.

code_lines <- "x <- 1\ny <<- 2"
writeLines(code_lines)
#> x <- 1
#> y <<- 2
lint(
  text = code_lines,
  linters = assignment_linter()
)
#> ℹ No lints found.

# customizing using arguments
code_lines <- "1 -> x\n2 ->> y"
writeLines(code_lines)
#> 1 -> x
#> 2 ->> y
lint(
  text = code_lines,
  linters = assignment_linter(allow_right_assign = TRUE)
)
#> Warning: Argument allow_right_assign was deprecated in lintr version 3.2.0. Use "->" in operator instead.
#> ℹ No lints found.

lint(
  text = "x <<- 1",
  linters = assignment_linter(allow_cascading_assign = FALSE)
)
#> Warning: Argument allow_cascading_assign was deprecated in lintr version 3.2.0. Use "<<-" and/or "->>" in operator instead.
#> <text>:1:3: style: [assignment_linter] Replace <<- by assigning to a specific environment (with assign() or <-) to avoid hard-to-predict behavior.
#> x <<- 1
#>   ^~~

writeLines("foo(bar = \n 1)")
#> foo(bar = 
#>  1)
lint(
  text = "foo(bar = \n 1)",
  linters = assignment_linter(allow_trailing = FALSE)
)
#> <text>:1:9: style: [assignment_linter] Assignment = should not be trailing at the end of a line.
#> foo(bar = 
#>         ^

lint(
  text = "x %<>% as.character()",
  linters = assignment_linter(allow_pipe_assign = TRUE)
)
#> Warning: Argument allow_pipe_assign was deprecated in lintr version 3.2.0. Use "%<>%" in operator instead.
#> ℹ No lints found.

lint(
  text = "x = 1",
  linters = assignment_linter(operator = "=")
)
#> ℹ No lints found.