styler: transform_file – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

transform_file

Transform a file and output a customized message

Transforms file contents and outputs customized messages.

transform_file(
  path,
  fun,
  max_char_path,
  message_before = "",
  message_after = " [DONE]",
  message_after_if_changed = " *",
  ...,
  dry
)

`path`	A vector with file paths to transform.
`fun`	A function that returns a character vector.
`max_char_path`	The number of characters of the longest path. Determines the indention level of `message_after`.
`message_before`	The message to print before the path.
`message_after`	The message to print after the path.
`message_after_if_changed`	The message to print after `message_after` if any file was transformed.
`...`	Further arguments passed to `transform_utf8()`.
`dry`	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.

Non-Invasive Pretty Printing of R Code

v1.4.1

MIT + file LICENSE

Authors

Kirill Müller [aut], Lorenz Walthert [cre, aut]

Initial release