style_pkg: Prettify R source code

Description

Performs various substitutions in all .R files in a package (code and tests). Carefully examine the results after running this function!

Usage

style_pkg(pkg = ".", ..., style = tidyverse_style,
  transformers = style(...), filetype = "R",
  exclude_files = "R/RcppExports.R")

Arguments

pkg

Path to a (subdirectory of an) R package.

...

Arguments passed on to the style function.

style

A function that creates a style guide to use, by default tidyverse_style() (without the parentheses). Not used further except to construct the argument transformers. See style_guides() for details.

transformers

A set of transformer functions. This argument is most conveniently constructed via the style argument and .... See 'Examples'.

filetype

Vector of file extensions indicating which filetypes should be styled. Case is ignored, and the . is optional, e.g. c(".R", ".Rmd") or c("r", "rmd").

exclude_files

Character vector with paths to files that should be excluded from styling.

Value

Invisibly returns a data frame that indicates for each file considered for styling whether or not it was actually changed.

Warning

This function overwrites files (if styling results in a change of the code to be formatted). It is strongly suggested to only style files that are under version control or to create a backup copy.

Examples

Run this code

# NOT RUN {
style_pkg(style = tidyverse_style, strict = TRUE)
style_pkg(
  scope = "line_breaks",
  math_token_spacing = specify_math_token_spacing(zero = "'+'")
)
# }

Run the code above in your browser using DataLab

Hear from leaders powering AI transformation