byName.GenericDataFileSet: Locates and sets up a file set by its name

In HenrikBengtsson/R.filesets: Easy Handling of and Access to Files Organized in Structured Directories

Locates and sets up a file set by its name

Description

Locates and sets up a file set by its name, tags, root and sub directories.

Usage

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

## Don't use the below:
## S3 method for class 'GenericDataFileSet'
byName(static, name, tags=NULL, subdirs=NULL, paths=NULL, ..., 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.
...	Not used.
verbose	...

Value

Returns a GenericDataFileSet. If not found, an exception is thrown.

Author(s)

Henrik Bengtsson

See Also

Internally, *findByName() is used to locate the data set, and *byPath() to then set it up. For more information see GenericDataFileSet.

HenrikBengtsson/R.filesets documentation built on Jan. 31, 2024, 8:11 a.m.