Skip to contents

Convert an object into a tibble-flowCore abstraction (a `tof_tbl`)

Usage

# S3 method for flowSet
as_tof_tbl(
  flow_data,
  .name_method = c("tidyFlowCore", "featureNames", "colnames"),
  sep = "|",
  ...,
  include_metadata = FALSE,
  include_tidyFlowCore_identifier = FALSE
)

Arguments

flow_data

A FlowSet

.name_method

A string indicating how tidyFlowCore should extract column names for the output tof_tbl from `flow_data`. Available options are "tidyFlowCore" (the default), which uses tidyFlowCore's internal heuristic to name columns; "featureNames", which uses featureNames to name the columns; and "colnames", which uses colnames to name the columns.

sep

A string to use to separate the antigen name and its associated channel name in the column names of the output tibble. Defaults to "|".

...

Currently unused.

include_metadata

A boolean value indicating if the metadata for each .fcs file read by flowCore (stored in pData) should be merged into the final result. Defaults to FALSE.

include_tidyFlowCore_identifier

A boolean value indicating if tidyFlowCore's internal identifier for each flowFrame in the flowSet should be included in the output tof_tbl result. Defaults to FALSE.

Value

A cytometry-specialized tibble called a `tof_tbl`.