wflow_rename renames files and directories. If the file to be renamed
is an R Markdown file, the corresponding HTML and other related files are
also renamed. If the workflowr project uses Git,
wflow_rename(files, to, message = NULL, git = TRUE, dry_run = FALSE, project = ".")
character. Files to be renamed. Supports file globbing.
character. New names for the files. Must be the same length as
character (default: NULL). A commit message.
logical (default: TRUE). Commit the changes (only applicable if Git repository is present).
logical (default: FALSE). Preview the files to be renamed but do not actually rename them.
character (default: ".") By default the function assumes the current working directory is within the project. If this is not true, you'll need to provide the path to the project directory.
An object of class
wflow_rename, which is a list with the
files: The relative path(s) to the renamed file(s).
to: The new relative path(s) to rename the file(s).
message: The message describing the commit (if applicable).
git: The input argument
dry_run: The input argument
commit:The object returned by
commit (only included if
files_git: The relative path(s) to the file(s) renamed from the Git repository.