ifcb_read_features: Read Feature Files from a Specified Folder or File Paths

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

Read Feature Files from a Specified Folder or File Paths

Description

This function reads feature files from a given folder or a specified set of file paths, optionally filtering them based on whether they are multiblob or single blob files.

Usage

ifcb_read_features(
  feature_files = NULL,
  multiblob = FALSE,
  feature_version = NULL,
  biovolume_only = FALSE,
  verbose = TRUE
)

Arguments

feature_files	A path to a folder containing feature files or a character vector of file paths.
multiblob	Logical indicating whether to filter for multiblob files (default: FALSE).
feature_version	Optional numeric or character version to filter feature files by (e.g. 2 for "_v2"). Default is NULL (no filtering).
biovolume_only	Logical; if TRUE, only a minimal set of feature columns required for biovolume calculations are read from each feature file (typically roi_number and biovolume). This substantially reduces memory usage and improves performance when other features are not needed. If FALSE, all available feature columns are read.
verbose	Logical. Whether to display progress information. Default is TRUE.

Value

A named list of data frames, where each element corresponds to a feature file read from feature_files. The list is named with the base names of the feature files.

Examples

## Not run: 
# Read feature files from a folder
features <- ifcb_read_features("path/to/feature_folder")

# Read only multiblob feature files
multiblob_features <- ifcb_read_features("path/to/feature_folder", multiblob = TRUE)

# Read only version 4 feature files
v4_features <- ifcb_read_features("path/to/feature_folder", feature_version = 4)

# Read feature files from a list of file paths
features <- ifcb_read_features(c("path/to/file1.csv", "path/to/file2.csv"))

## End(Not run)

iRfcb documentation built on Jan. 8, 2026, 1:06 a.m.