data_file_matches-methods: Generic function to test whether a file name conforms to the...

In bbuchsbaum/neuroim2: Data Structures and IO for Neuroimaging Data with an Emphasis on Functional Magnetic Resonance Imaging (FMRI)

Generic function to test whether a file name conforms to the given a FileFormat instance. Will test for match to data file only

Description

Validates whether a file name conforms to the data file format specification.

Usage

data_file_matches(x, file_name)

## S4 method for signature 'FileFormat,character'
data_file_matches(x, file_name)

Arguments

x	A FileFormat object specifying the format requirements
file_name	A character string specifying the file name to validate

Details

The function performs case-sensitive pattern matching to verify that the file name ends with the specified data extension. The match is performed using a regular expression that ensures the extension appears at the end of the file name.

Value

TRUE for match, FALSE otherwise

A logical value: TRUE if the file name matches the data format, FALSE otherwise

See Also

file_matches, header_file_matches for related file format validation

Examples

## Not run: 
fmt <- new("FileFormat", header_extension = "hdr", data_extension = "img")
data_file_matches(fmt, "brain_scan.img")  # TRUE
data_file_matches(fmt, "brain_scan.hdr")  # FALSE
data_file_matches(fmt, "brain.img.gz")    # FALSE

## End(Not run)

bbuchsbaum/neuroim2 documentation built on Jan. 2, 2025, 3:38 p.m.