Performs various substitutions in all .R, .Rmd, .Rmarkdown, qmd
and/or .Rnw files in a directory (by default only .R files are styled -
see filetype argument).
Carefully examine the results after running this function!
Path to a directory with files to transform.
Arguments passed on to the style function,
see tidyverse_style() for the default argument.
A function that creates a style guide to use, by default
tidyverse_style. Not used
further except to construct the argument transformers. See
style_guides() for details.
A set of transformer functions. This argument is most
conveniently constructed via the style argument and .... See
'Examples'.
Vector of file extensions indicating which file types should
be styled. Case is ignored, and the . is optional, e.g. c(".R",".Rmd"),
or c("r", "rmd"). Supported values (after standardization) are:
"qmd", "r", "rmd", "rmarkdown", "rnw", and "rprofile".
Rmarkdown is treated as Rmd.
A logical value indicating whether or not files in
sub directories of path should be styled as well.
Character vector with regular expressions to files that should be excluded from styling.
Character vector with directories to exclude (recursively).
Whether or not to style code in roxygen examples.
Integer scalar indicating by how many spaces the whole
output text should be indented. Note that this is not the same as splitting
by line and add a base_indention spaces before the code in the case
multi-line strings are present. See 'Examples'.
To indicate whether styler should run in dry mode, i.e. refrain
from writing back to files ."on" and "fail" both don't write back, the
latter returns an error if the input code is not identical to the result
of styling. "off", the default, writes back if the input and output of
styling are not identical.
Invisibly returns a data frame that indicates for each file considered for
styling whether or not it was actually changed (or would be changed when
dry is not "off").
This function overwrites files (if styling results in a change of the
code to be formatted and dry = "off"). It is strongly suggested to only
style files that are under version control or to create a backup copy.
We suggest to first style with scope < "tokens" and inspect and commit
changes, because these changes are guaranteed to leave the abstract syntax
tree (AST) unchanged. See section 'Round trip validation' for details.
Then, we suggest to style with scope = "tokens" (if desired) and carefully
inspect the changes to make sure the AST is not changed in an unexpected way
that invalidates code.
The following section describes when and how styling is guaranteed to yield correct code.
If tokens are not in the styling scope (as specified with the scope
argument), no tokens are changed and the abstract syntax tree (AST) should
not change.
Hence, it is possible to validate the styling by comparing whether the parsed
expression before and after styling have the same AST.
This comparison omits roxygen code examples and comments. styler throws an
error if the AST has changed through styling.
Note that if tokens are to be styled, such a comparison is not conducted because the AST might well change and such a change is intended. There is no way styler can validate styling, that is why we inform the user to carefully inspect the changes.
See section 'Warning' for a good strategy to apply styling safely.
Other stylers:
style_file(),
style_pkg(),
style_text(),
styler_addins
if (FALSE) {
style_dir("path/to/dir", filetype = c("rmd", ".R"))
# the following is identical (because of ... and defaults)
# but the first is most convenient:
style_dir(strict = TRUE)
style_dir(style = tidyverse_style, strict = TRUE)
style_dir(transformers = tidyverse_style(strict = TRUE))
}