R.filesets: findByName.GenericDataFileSet – R documentation

Pricing

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

Get Started for Free

Documentation

R.filesets

findByName.GenericDataFileSet

Locates all file sets that match the requested name

Description

Locates all file sets that match the requested name, tags, and sub directories, in any of the root paths.

Usage

## Static method (use this):
## GenericDataFileSet$findByName(name, tags=NULL, subdirs=NULL, paths=NULL,
##   firstOnly=TRUE, mustExist=FALSE, ..., verbose=FALSE)

## Don't use the below:
## S3 method for class 'GenericDataFileSet'
findByName(static, name, tags=NULL, subdirs=NULL, paths=NULL, firstOnly=TRUE,
  mustExist=FALSE, ..., verbose=FALSE)

Arguments

`name, tags`	The name and the tags of the file set to be located.
`subdirs`	A `character` `vector` of the subpath where the file set is located.
`paths`	A `character` `vector` of root paths where to look for the file set.
`firstOnly`	If `TRUE`, only the first path found, if any, is returned, otherwise all found paths are returned.
`mustExist`	If `TRUE`, an exception is thrown if the file set was not found, otherwise not.
`...`	Not used.
`verbose`	...

Value

Returns a character vector of paths. If no file sets were found, NULL is returned.

Author(s)

Henrik Bengtsson