doTransform: A Convenience Wrapper for Transformation

In rogerswt/wadeTools: Wade's Hodgepodge of Flow Cytometry Functions

A Convenience Wrapper for Transformation

Description

Convenience wrapper for transformList and transform.

Usage

doTransform(
  ff,
  cols = c(1:5, 7:13),
  method = c("biexp", "asinh", "log", "linear"),
  a = 0.002,
  cofactor = 5,
  fac = 5.4/262143
)

Arguments

ff	The flowFrame to be transformed
cols	The columns (parameters) of the flowFrame to be transformed
method	The transformation function. One of biexp, log or linear.
a	The adjustable parameter for Wade's biexpTransform (Default = 0.002)
cofactor	The adjustable parameter for Wade's asinhTransform (Default = 5)
fac	The scaling factor used only for method = 'linear'.

Details

Please refer to the code for the math details. The biexp and asinh methods are specific to this package. They're similar to other corresponding transforms (e.g. flowCore, FlowJo) but differ in detail. The values of the two adjustable transformation parameters a and cofactor are only applicable to their corresponding transforms.

Value

The transformed flowFrame.

rogerswt/wadeTools documentation built on Feb. 16, 2023, 7:47 a.m.