usethis: use_build_ignore – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

use_build_ignore

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

Automate Package and Project Setup

v2.0.1

MIT + file LICENSE

Authors

Hadley Wickham [aut] (<https://orcid.org/0000-0003-4757-117X>), Jennifer Bryan [aut, cre] (<https://orcid.org/0000-0002-6983-2759>), RStudio [cph, fnd]

Initial release