rename_function: Rename a function

Description Usage Arguments Author(s)

View source: R/rename_function.R

Description

Renames a function in a file

Usage

1
2
3
4
rename_function(name, new_name, file_name, language = "R",
  calls = TRUE, defs = TRUE, examples = TRUE, characters = TRUE,
  comments = TRUE, docs = TRUE, verbosity_level = "normal",
  idle_mode = FALSE)

Arguments

name

'character' string giving a function name to be renamed

new_name

'character' string giving a new name of the function

language

'character' string giving a language in which file is written. Currently supported language is R

calls

'logical' value. Should the function be renamed in calls?

defs

'logical' value. Should the function be renamed in definitions?

examples

'logical' value. Should the function be renamed in examples in documentation?

characters

'logical' value. Should the function be renamed in literal character vectors? This option do not make difference between the function and other objects!

comments

'logical' value. Should function be renamed in comments? This option do not make difference between the function and other objects!

docs

'logical' value. Should function be renamed in text in documentation? This option do not make difference between the function and other objects!

verbosity_level

'logical' value. Allows changing amount of the information printed in the console.

idle_mode

'logical' value. If 'TRUE', changes will not be applied, only information will be printed.

Author(s)

Dominik Rafacz


DominikRafacz/refactoR documentation built on Oct. 30, 2019, 5:25 p.m.