fritools (version 3.3.0)

find_files: Find Files on Disk

Description

Look for files on disk, either scanning a vector of names or searching for files with list.files and throw an error if no files are found.

Usage

find_files(
  file_names = NA,
  path = ".",
  pattern = ".*\\.[RrSs]$|.*\\.[RrSs]nw$",
  all_files = TRUE,
  recursive = FALSE,
  ignore_case = FALSE,
  find_all = FALSE,
  select = NA
)

Arguments

file_names

character vector of file names (to be checked if the files exist).

path

see list.files.

pattern

see list.files.

all_files

see list.files, argument all.files.

recursive

see list.files.

ignore_case

see list.files, argument ignore.case.

find_all

Throw an error if not all files (given by file_names) are found?

select

A named list of numerical vectors of maximum length 2 named min and/or max. If given, file searching will be restricted to file attributes corresponding to the names in the list ranging between min and max. See examples.

Value

A character vector of file names.

Details

This is a wrapper to either file.exists or list.files, that ensures that (some) files exists. This may come handy if you want to perform some kind of file manipulation e.g. with one of the functions listed under See Also Other file utilities:.

See Also

Other searching functions: compare_vectors(), file_modified_last(), fromto(), missing_docs, search_files(), search_rows(), summary.filesearch()

Other file utilities: file_copy(), file_modified_last(), file_save(), get_mtime(), get_unique_string(), is_files_current(), is_path(), paths, search_files(), split_code_file(), touch()

Examples

# NOT RUN {
#% create some files
files <- unname(sapply(file.path(tempdir(), paste0(sample(letters, 10),
                                              ".", c("R", "Rnw", "txt"))),
                       touch))
print(files)
print(list.files(tempdir(), full.names = TRUE)) # same as above
#% file names given
find_files(file_names = files[1:3])
##% some do not exist:
find_files(file_names = c(files[1:3], replicate(2, tempfile())))
try(find_files(file_names = c(files[1:3], replicate(2, tempfile())),
               find_all = TRUE))
##% all do not exist:
try(find_files(file_names = replicate(2, tempfile())))
#% path given
find_files(path = tempdir())
##% change pattern
find_files(path = tempdir(),
           pattern = ".*\\.[RrSs]$|.*\\.[RrSs]nw$|.*\\.txt")
##% find a specific file by it's basename
find_files(path = tempdir(), pattern = paste0("^", basename(files[1]), "$"))
#% file_names and path given: file_names beats path
try(find_files(file_names = tempfile(), path = tempdir()))
#% select by file size:
write.csv(mtcars, file.path(tempdir(), "mtcars.csv"))
find_files(path = tempdir(), pattern = ".*")
find_files(path = tempdir(), pattern = ".*",
           select = list(size = c(min = 1000))
           )
# }