ifcb_read_hdr_data: Read Data from IFCB HDR Files

In iRfcb: Tools for Managing Imaging FlowCytobot (IFCB) Data

Read Data from IFCB HDR Files

Description

This function reads all IFCB instrument settings information files (.hdr) from a specified directory.

Usage

ifcb_read_hdr_data(
  hdr_files,
  gps_only = FALSE,
  verbose = TRUE,
  hdr_folder = deprecated()
)

Arguments

hdr_files	A character string or character vector specifying the path(s) to .hdr files, or a single folder path.
gps_only	A logical value indicating whether to include only GPS information (latitude and longitude). Default is FALSE.
verbose	A logical value indicating whether to print progress messages. Default is TRUE.
hdr_folder	Use hdr_files instead, which also accepts a single folder path. This rename applies to this function only, because hdr_files takes a vector of file paths as well as a folder. It is not a package-wide rename: functions that genuinely take one directory, such as ifcb_psd() and ifcb_summarize_biovolumes(), keep hdr_folder.

Value

A data frame with sample names, GPS latitude, GPS longitude, and timestamps. When gps_only = TRUE, only samples with GPS coordinates are included.

Examples

## Not run: 
# Extract all HDR data
hdr_data <- ifcb_read_hdr_data("path/to/data")
print(hdr_data)

# Extract only GPS data
gps_data <- ifcb_read_hdr_data("path/to/data", gps_only = TRUE)
print(gps_data)

## End(Not run)

iRfcb documentation built on Aug. 20, 2026, 1:06 a.m.