checkFcsFiles: Check a list of FCS files for a number of potential issues

In BenaroyaResearch/briDiscovr: Distribution analysis across clusters of a parent population overlaid with a rare subpopulation

Check a list of FCS files for a number of potential issues

Description

Internal function used by briDiscovr to verify FCS file locations, integrity, and optionally size relative to system memory. Split out as a separate function because it is used by multiple other functions in this package. Steps formerly contained with setupDiscovrExperiment.

Usage

checkFcsFiles(fcsInfo, checkMemory = TRUE, verbose = TRUE)

Arguments

fcsInfo	A data frame containing file locations and information for data to be included in a briDiscovr analysis. Typically loaded by another briDiscovr function by specifying fcsInfoFile
checkMemory	(default: TRUE) Logical indicating whether to check how much system memory is available before loading the dataset. If TRUE, this function will display a message and prevent data loading when the files take up more than 80 percent of the available system memory.
verbose	(default: TRUE) Logical specifying whether to display processing messages

Value

logical, TRUE if the files in fcsInfo pass all checks. Function should exit with a stop statement if any checks are failed.

Author(s)

Mario G Rosasco

Virginia Muir

Matthew J Dufort, [e-mail]

See Also

setupDiscovrExperiment, downsampleFcsList

BenaroyaResearch/briDiscovr documentation built on March 15, 2024, 12:31 a.m.