arcTrans: Efficient inverse hyperbolic cosine transformation

In jtheorell/theFlowSpec: Tools for spectral unmixing of overdetermined flow-cytometry files. And other nice things.

Description

This is a simple wrapper function for the base asinh function, that is useful for flowFrames and flowSets. It also allows for reversing the transformation with the argument reverse

Usage

arcTrans(flowObj, transNames, transCoFacs = "default", unTrans = FALSE)

Arguments

flowObj	The fcs object to be transformed. Both flowFrames and flowSets are accepted.
transNames	The variables that should be normalized.
transCoFacs	This vector of values define the values for the transformation during the normalization. In the "default" case, the function defines the object as a CyTOF object if >5 percent of the values are 0, and applies the transformation value 8. Otherwise, the value 256 is applied.
unTrans	If the reverse action should be taken, i.e. if an already transformed dataset should be un-transformed. NB! It is of great importance that the same transformation factors are used!

Value

A flow object containing the transformed data, and with all metadata left untouched.

jtheorell/theFlowSpec documentation built on Aug. 22, 2019, 3:33 a.m.