FileSet-class: The FileSet class

In tractor.base: Read, Manipulate and Visualise Magnetic Resonance Images

The FileSet class

Description

This reference class manages sets of related files based on a common file stem and required and/or optional suffixes. It is designed for handling alternative file formats or composite file types. The class represents the group of file formats in the abstract; its methods handle specific files and support operations such as copying, moving, symlinking, validating and deleting those files, ensuring that all constituent files are handled consistently.

Fields

formats

A named list mapping format names to required file suffixes.

validators

An optional named list of validation functions for some or all of the supported formats.

auxiliaries

A character vector of optional auxiliary file suffixes.

Methods

atPaths(paths)

Return a handle object to manipulate files at specific paths

fileStem(paths)

Obtain a file stem for each specified path, dropping format-specific suffixes

findFormat(paths, intent = c("read", "write"), preference = NULL, all = FALSE)

Identify and potentially validate files to find the format used at specific paths

resolvePaths(paths)

Perform any special path handling and resolve final paths

subset(match, ...)

Create a variant object that only encapsulates the specified subset of formats

See Also

ImageFileSet is a subclass specialised for image files.

tractor.base documentation built on Nov. 5, 2025, 6:18 p.m.