Code Convertion

library(rpkgkit)

Qualify package function calls

make_func_call_explicit() adds namespace qualifiers to calls from selected packages. package_func_call_explicit() applies the same operation throughout a package.

file <- tempfile(fileext = ".R")
writeLines(
  c(
    "starwars |>",
    "  mutate(name, bmi = mass / ((height / 100)^2)) |>",
    "  select(name:mass, bmi)"
  ),
  file
)

make_func_call_explicit(file, use_packages = "dplyr")
#> ℹ Retrieving function calls from dplyr
#> ✔ Successfully made function call explicit in /tmp/RtmpuEZLQ7/file1daa2741551a.R
readLines(file) |> cli::cli_code()
#> starwars |>
#>   dplyr::mutate(name, bmi = mass / ((height / 100)^2)) |>
#>   dplyr::select(name:mass, bmi)

Find unmatched glue braces

detect_lost_glue_brace() checks one file; package_lost_glue_brace() checks an entire package. Both support glue and cli expressions.

file <- tempfile(fileext = ".R")
writeLines(
  c(
    'name <- "world"',
    'msg <- glue::glue("Hello, {name!")',
    'cli::cli_alert_warning("{.field warning}}")'
  ),
  file
)

detect_lost_glue_brace(file)
#> msg <- glue::glue("Hello, {name!")
#>                           ^^^^^^
#> cli::cli_alert_warning("{.field warning}}")
#>                         ^^^^^^^^^^^^^^^^^
#> ✖ Found 2 lines with mismatched braces: 2 and 3

Name positional arguments

make_func_arg_explicit() makes arguments in one file explicit, and package_func_arg_explicit() applies this transformation across a package.

file <- tempfile(fileext = ".R")
writeLines("vapply(1:9, function(x) x * 2, numeric(1))", file)
make_func_arg_explicit(file)
#> ✔ Made function arguments explicit in /tmp/RtmpuEZLQ7/file1daa571ceaa1.R
readLines(file) |> cli::cli_code()
#> vapply(X = 1:9, FUN = function(x) x * 2, FUN.VALUE = numeric(length = 1))

Rename functions

Use rename_func() to apply a naming style to function definitions in a file.

file <- tempfile(fileext = ".R")
writeLines("this_is_a_function <- function() message('Hello, world')", file)
rename_func(file, style = "camelCase")
#> ✔ Renamed 1 function to "camelCase" style in /tmp/RtmpuEZLQ7/file1daaf567528.R
readLines(file) |> cli::cli_code()
#> thisIsAFunction <- function() message('Hello, world')

Detect print() and cat()

detect_print_and_cat() reports print() and cat() calls in one file. package_print_and_cat() checks an entire package. Set fix = TRUE to replace those calls in the selected file with message().

file <- tempfile(fileext = ".R")
writeLines("print('Hello, world')", file)
detect_print_and_cat(file)
#> print('Hello, world') [message]
#> ^^^^^^
#> ✖ Found 1 unsupported call on line 1.

detect_print_and_cat(file, fix = TRUE)
#> ✔ Fixed 1 line in file1daa52268768.R.
#> print('Hello, world') [message]
#> ^^^^^^
#> ✖ Found 1 unsupported call on line 1.
readLines(file) |> cli::cli_code()
#> message('Hello, world')

Convert function syntax

Convert between function() and the short \() syntax.

file <- tempfile(fileext = ".R")
writeLines("f <- function(x) x^2", file)
convert_func_syntax(file, "to_lambda")
#> ✔ Converted function definitions in /tmp/RtmpuEZLQ7/file1daa4d54b987.R to "to_lambda"
readLines(file) |> cli::cli_code()
#> f <- \(x) x^2

convert_func_syntax(file, "to_explicit")
#> ✔ Converted function definitions in /tmp/RtmpuEZLQ7/file1daa4d54b987.R to "to_explicit"
readLines(file) |> cli::cli_code()
#> f <- function(x) x^2

Modernize knitr chunk headers

convert_knitr_chunk_header() converts legacy R Markdown chunk options to the current comment-based syntax.

file <- tempfile(fileext = ".Rmd")
writeLines(c("```{r, echo=TRUE, fig.width=10}", "x <- 1", "```"), file)
convert_knitr_chunk_header(file)

#> ℹ Converting knitr chunk headers in /tmp/RtmpuEZLQ7/file1daa7e92e038.Rmd
readLines(file) |> cli::cli_code()

#> ```{r}
#> #| echo = TRUE,
#> #| fig.width = 10
#> x <- 1
#> ```

Add integer suffixes

convert_int_literals() adds L to bare integer literals while leaving strings, comments, floating-point values, and existing suffixes unchanged.

file <- tempfile(fileext = ".R")
writeLines("x <- seq_len(10) # length 10", file)
convert_int_literals(file)
#> ✔ Added explicit integer suffixes in /tmp/RtmpuEZLQ7/file1daa74812706.R
readLines(file) |> cli::cli_code()
#> x <- seq_len(10L) # length 10

Use package_convert_int_literals() to process .R and .r files below a package’s R/ and tests/ directories.

package_convert_int_literals(".")

Convert non-ASCII source code

convert_nonascii_code() converts non-ASCII source to Unicode escape sequences when needed for CRAN-compatible source files. It accepts either a file path or an R expression.

file <- tempfile()
writeLines("foo <- \\() message('滚滚长江东逝水')", file)
convert_nonascii_code(file, overwrite = TRUE)
#> ℹ Converted content written to /tmp/RtmpuEZLQ7/file1daa47043c95
readLines(file) |> cli::cli_code()
#> foo <- \() message('\u6eda\u6eda\u957f\u6c5f\u4e1c\u901d\u6c34')

convert_nonascii_code({
  cli::cli_alert_info("明月几时有")
  cli::cli_alert_warning("把酒问青天")
})
#> ℹ Converted code (copy from console):
#> {
#>   cli::cli_alert_info("\u660e\u6708\u51e0\u65f6\u6709")
#>   cli::cli_alert_warning("\u628a\u9152\u95ee\u9752\u5929")
#> }