Skip to contents

Match Package Name

Source: R/match_pkg_name.R
match_pkg_name.Rd

Match a package name to the content of files.

Usage

match_pkg_name(
  pkg_name = basename(getwd()),
  pkg_dir = ".",
  file_patterns = c("\\NEWS", "\\README", "\\_pkgdown"),
  warn_files_absent = FALSE
)

Arguments

pkg_name

character string: the package name that should be present in the checked fields and files.

pkg_dir

character string: the path to the directory where to look for files. Subdirectories are not checked.

file_patterns

character vector containing regular expressions to match to file names in pkg_dir, using case-insensitive matching. Can be character(0) to not check any files. Hidden files (i.e., files with names starting with a dot) are not found.

warn_files_absent

TRUE or FALSE: warn if files matching file_patterns are absent from pkg_dir, or if citation_fields is not character(0) and the CITATION file is absent from pkg_dir. Missing files are silently ignored if warn_files_absent is FALSE.

Value

The paths to the files that were checked, returned invisibly.

See also

pkg_name_correct(), usethis::use_news_md(), usethis::use_pkgdown()

Examples

match_pkg_name(pkg_name = "develcoder",
               warn_files_absent = FALSE)
match_pkg_name(pkg_name = "develcoder",
               warn_files_absent = TRUE)
#> Warning: No files found matching pattern '\NEWS'
#> Warning: No files found matching pattern '\README'
#> Warning: No files found matching pattern '\_pkgdown'