File: use_build_ignore.Rd

package info (click to toggle)
r-cran-usethis 3.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,228 kB
  • sloc: sh: 26; makefile: 17; cpp: 6; ansic: 3
file content (31 lines) | stat: -rw-r--r-- 1,039 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ignore.R
\name{use_build_ignore}
\alias{use_build_ignore}
\title{Add files to \code{.Rbuildignore}}
\usage{
use_build_ignore(files, escape = TRUE)
}
\arguments{
\item{files}{Character vector of path names.}

\item{escape}{If \code{TRUE}, the default, will escape \code{.} to
\verb{\\\\.} and surround with \code{^} and \code{$}.}
}
\description{
\code{.Rbuildignore} has a regular expression on each line, but it's
usually easier to work with specific file names. By default,
\code{use_build_ignore()} will (crudely) turn a filename into a regular
expression that will only match that path. Repeated entries will be
silently removed.

\code{use_build_ignore()} is designed to ignore \emph{individual} files. If you
want to ignore \emph{all} files with a given extension, consider providing
an "as-is" regular expression, using \code{escape = FALSE}; see examples.
}
\examples{
\dontrun{
# ignore all Excel files
use_build_ignore("[.]xlsx$", escape = FALSE)
}
}