header_file {neuroim2} | R Documentation |
Generic function to get the name of the header file, given a file name and a FileFormat
instance.
Description
Derives the header file name from a given file name based on the FileFormat specifications.
Usage
header_file(x, file_name)
## S4 method for signature 'FileFormat,character'
header_file(x, file_name)
Arguments
x |
A FileFormat object specifying the format requirements |
file_name |
A character string specifying the file name to derive the header file name from |
Details
The function performs the following steps:
If the input file_name already matches the header file format, it returns the file_name as is.
If the file_name matches the data file format, it constructs and returns the corresponding header file name.
If the file_name doesn't match either format, it throws an error.
Value
The correct header file name as a character
string.
A character string representing the header file name
See Also
data_file
, strip_extension
for related file name
manipulation
Examples
fmt <- new("FileFormat", header_extension = "hdr", data_extension = "img")
header_file(fmt, "brain_scan.hdr") # Returns "brain_scan.hdr"
header_file(fmt, "brain_scan.img") # Returns "brain_scan.hdr"
[Package neuroim2 version 0.8.1 Index]