Skip to contents

Switch Between the Tidyverse Pipe %>% and the Base Pipe |>

Source: R/21A_package_convert_pipe.R, R/21_convert_pipe.R
convert_pipe.Rd

Rewrites pipe operators in an R file between the magrittr pipe %>% and the base pipe |>. Strings, comments, and raw strings are left unchanged, so a mention of either operator in documentation or a character literal is not rewritten.

convert_pipe() operates on one R file. When path is NULL and RStudio is available, it uses the currently active document. package_convert_pipe() walks selected directories of an R package and applies the same conversion to every .R / .r file found, except automatically generated RcppExports.R files.

The placeholder pipe %<>% and the exposition pipe %$% are not pipes in this sense and are left untouched.

Usage

package_convert_pipe(
  path = NULL,
  direction = c("to_base", "to_magrittr"),
  dirs = c("R"),
  recursive = TRUE,
  ...
)

convert_pipe(
  path = NULL,
  direction = c("to_base", "to_magrittr"),
  verbose = TRUE,
  ...
)

Arguments

path

For convert_pipe(), a character string specifying the R file to modify. If NULL and RStudio is available, the currently active document path is used.

For package_convert_pipe(), a character string specifying the package root. If NULL, the current working directory is used.

direction

Conversion direction. One of:

  • "to_base": convert %>% to |>

  • "to_magrittr": convert |> to %>%

dirs

Character vector of subdirectories relative to path to search. Used only by package_convert_pipe(). Defaults to c("R").

recursive

Logical; recurse into subdirectories. Used only by package_convert_pipe(). Default TRUE.

...

Additional arguments. Currently unused and must be empty.

verbose

Logical; enable or disable per-file messages. Used only by convert_pipe(). Default TRUE.

Value

Both functions are called for their side effect and invisibly return TRUE when they convert something. When there is nothing to convert, FALSE is returned

Details

Rewriting is a literal match, so only a complete operator is converted:

  • %>% becomes |>, and |> becomes %>%.

  • Matching is literal, so % > % (whitespace inside the operator) is not converted, and %<>%, %$%, and longer operators such as %myop% are left unchanged.

  • |> is matched only when % does not immediately precede it, so the tail of an operator such as %|>% is not treated as a base pipe.

  • Occurrences inside string literals, raw strings, and comments are left unchanged.

Examples

if (FALSE) { # \dontrun{
# --- Single file ---
temp <- tempfile(fileext = ".R")
writeLines("mtcars |> dplyr::filter(cyl > 4)", temp)
convert_pipe(temp, direction = "to_magrittr")
readLines(temp)
# "mtcars %>% dplyr::filter(cyl > 4)"

# --- Entire package ---
tmp_pkg <- tempdir()
usethis::create_package(tmp_pkg, open = FALSE)
writeLines("mtcars %>% dplyr::filter(cyl > 4)", file.path(tmp_pkg, "R/foo.R"))
package_convert_pipe(tmp_pkg, direction = "to_base")
readLines(file.path(tmp_pkg, "R/foo.R"))
} # }