Create a Boilerplate Package .gitignore File — pkg

Creates a boilerplate package .gitignore file.

pkg_gitignore(pkg_root, add = NULL, docs = TRUE, msg = ".gitignore file path:")

Arguments

pkg_root	Character string. Package root directory.
add	Character string. Entries to the `.gitignore` in addition to the boilerplate example.
docs	Character string. Ignore `docs` containing `pkgdown` files.
msg	Character string. Optional message. If supplied, prints `msg dir/fn`.

Details

Note that if pkg_create() is used, this function will be called.

If .gitignore exists in the specified package root directory, it will NOT be overwritten. Additional entries in the add argument will be appended.

Author

Ivan Jacob Agaloos Pesigan

Examples

if (FALSE) {
pkg_gitignore(
  pkg_root = "~/boilerplatePackage"
)
}