add_to_gitignore: Add to the .gitignore file

In rcompendium: Create a Package or Research Compendium Structure

Add to the .gitignore file

Description

This function creates a .gitignore file at the root of the project based on a template (specific to R). If a .gitignore is already present, files to be untracked by git are just added to this file.

Usage

add_to_gitignore(x, open = FALSE, quiet = FALSE)

Arguments

x	A character vector. One or several files/folders names to be added to the .gitignore.
open	A logical value. If TRUE the .gitignore file is opened in the editor. Default is FALSE.
quiet	A logical value. If TRUE messages are deleted. Default is FALSE.

Value

No return value.

See Also

Other development functions: add_dependencies(), add_github_actions_check(), add_github_actions_citation(), add_github_actions_codecov(), add_github_actions_codemeta(), add_github_actions_document(), add_github_actions_pkgdown(), add_github_actions_render(), add_r_depend(), add_to_buildignore()

Examples

## Not run: 
add_to_gitignore(open = TRUE)
add_to_gitignore(".DS_Store")

## End(Not run)

rcompendium documentation built on Sept. 9, 2025, 5:29 p.m.