Changing the name of an existing R package is annoying but common task in the early stages of package development (at least for me). Package changer
tries to automate this task:
available
from available).All complete words matching the package name are replaced in all R scripts, C/C++/Fortran/Stan source codes, markdown files, and typical files in R packages, i.e. files with extension .R
, .cpp
, .c
, .h
, .f
, .f90
, .f95
, .stan
, .md
, .Rmd
, .Rnw
, .html
, and .bib
, as well as files DESCRIPTION
, NAMESPACE
inst/CITATION
, .Rbuildignore
, and gitignore
.
[oldname].Rproj
, [oldname]-package.R
, [oldname]-defunct.R
, and [oldname]-deprecated.R
.run_roxygen
is TRUE
(default), old Rd
files are removed..o
, .so
, and .dll
in /src
are removed to force a rebuild of the package.change_git
is TRUE
(default), the remote url of the git repository is changed to match the new name. Note that you still need to change the name of the repository in Github/Bitbucket etc manually. For example in Github: Go to the URL of your Github package, click Settings near the top-right, change the name under Repository name, and click Rename.If run_roxygen
is TRUE
, update documentation and rebuild package.
Inspired by back-and-forth naming of the package particlefields) and Nick Tierney’s blog post.
If the package is already published in CRAN, then you should first consult folks at CRAN whether they will accept the name change.
It is strongly recommended to have a backup backup before proceeding.
You can install the developed version of changer from Github with:
There is just one function in the package: