README.md

In bpollner/flowdex: Extract Fluorescence Distribution Data from FCS Files and Recalculate to Events per Volume

flowdex

Extract Fluorescence Distribution Data from FCS Files and Recalculate to Events per Volume

Description

Extract fluorescence distribution data from any bivariate distribution within a previously defined flow cytometry gating strategy and recalculate the fluorescence distribution to events per volume unit.

Additionally, any number of class- and numerical variables describing the dataset can be generated by providing a structured character string in the Sample-ID field of each individual sample at the time of data acquisition. At the time of reading in the fcs files, this structured character string is translated into class- and numerical variables, using a dictionary to translate any abbreviations into its long form.

Finally, the fluorescence-distribution data that were (possibly) re-calculated to events per volume unit can be visualised and exported to file, along with data denoting the overall events per volume unit in each sample in each gate.

To (meaningfully) use flowdex, the fcs files have to contain volumetric measurement data denoting the acquired sample volume.

flowdex is leaning heavily on the packages flowCoreand flowWorkspace for data import, generation of gating sets etc.

To sum it up, package flowdex can:

• Extract fluorescence distribution data from FCM files and recalculate them to events per volume unit,
• Generate variables describing the dataset by using a structured character string in the sample-Id field of the sample at the time of data acquisition, and
• Visualise fluorescence distributions and export them to file.

Advantage

Having ones hand directly on the rawdata of fluorescence distributions is not something the average desktop GUI of FCM-machines is providing easily or willingly. Package flowdex was designed to alleviate that problem.

Additionally, if the FCM-machine used for data acquisition does have a volumetric measurement module and the fcs files contain volumetric data, it is possible to re-calculate any extracted fluorescence distribution to events per volume unit.

In other words, the y-axis of any fluorescence distribution can be displayed in a fixed scale, i.e. events per volume unit. This enables the comparison of numbers on a fixed scale across samples, groups or experiments, instead of being confined to compare percentages of sub-groups of an overall population.

Installation

Install release version from CRAN via

install.packages("flowdex")

Or download from github:

library(devtools)
install_github(repo="bpollner/flowdex", ref="main")

Go to https://bpollner.github.io/flowdex/ to learn how to use flowdex.

bpollner/flowdex documentation built on March 31, 2022, 3:21 a.m.