use_build_ignore: Add files to '.Rbuildignore'

In usethis: Automate Package and Project Setup

Add files to .Rbuildignore

Description

.Rbuildignore has a regular expression on each line, but it's usually easier to work with specific file names. By default, use_build_ignore() will (crudely) turn a filename into a regular expression that will only match that path. Repeated entries will be silently removed.

use_build_ignore() is designed to ignore individual files. If you want to ignore all files with a given extension, consider providing an "as-is" regular expression, using escape = FALSE; see examples.

Usage

use_build_ignore(files, escape = TRUE)

Arguments

files	Character vector of path names.
escape	If TRUE, the default, will escape . to ⁠\\.⁠ and surround with ^ and $.

Examples

## Not run: 
# ignore all Excel files
use_build_ignore("[.]xlsx$", escape = FALSE)

## End(Not run)

usethis documentation built on Sept. 11, 2024, 5:29 p.m.