styler (version 0.0-8)

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(...), 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'.

exclude_files

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

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.

See Also

Other stylers: style_dir, style_file, style_text

Examples

# NOT RUN {
# the following is identical but the former is more convenient:
style_pkg(style = tidyverse_style, strict = TRUE)
style_pkg(transformers = tidyverse_style(strict = TRUE))
# }