debarcode: Debarcode an FCS file.

In ismmshimc/cytutils: Cytometry quality control and reproducibility utilities

Debarcode an FCS file.

Description

Import FCS file and barcoding key and run it through the debarcoding workflow: label events using Zunder et al., unlabel events according to barcoding separation distance and Mahalanobis ratio heuristics, and export each label to a separate file along with an accompanying diagnostic plot.

Usage

debarcode(fcs_file_path, key_file_path, export_files = TRUE,
  export_figures = TRUE, verbose = TRUE)

Arguments

fcs_file_path	FCS file path.
key_file_path	CSV barcoding key file path.
export_files	If TRUE, the function will export debarcoded FCS files.
export_figures	If TRUE, the function will export diagnostic plots.
verbose	If TRUE, the function will message the console with updates.

Details

Please note that this function ends with a series of warnings due to flowCore's write.FCS.

Value

A data frame with a row for every event. Columns are label, barcoding separation distance, and Mahalanobis ratio.

ismmshimc/cytutils documentation built on Aug. 26, 2022, 2:07 p.m.