arcsinhTransform {flowCore}R Documentation

Create the definition of an arcsinh transformation function (base specified by user) to be applied on a data set

Description

Create the definition of the arcsinh Transformation that will be applied on some parameter via the transform method. The definition of this function is currently x<-asinh(a+b*x)+c). The transformation would normally be used to convert to a linear valued parameter to the natural logarithm scale. By default a and b are both equal to 1 and c to 0.

Usage

arcsinhTransform(transformationId="defaultArcsinhTransform", a=1, b=1, c=0)

Arguments

transformationId

character string to identify the transformation

a

positive double that corresponds to a shift about 0.

b

positive double that corresponds to a scale factor.

c

positive double

Value

Returns an object of class transform.

Author(s)

B. Ellis

See Also

transform-class, transform, asinh

Other Transform functions: biexponentialTransform, inverseLogicleTransform, linearTransform, lnTransform, logTransform, logicleTransform, quadraticTransform, scaleTransform, splitScaleTransform, truncateTransform

Examples


samp <- read.FCS(system.file("extdata",
   "0877408774.B08", package="flowCore"))
  asinhTrans <- arcsinhTransform(transformationId="ln-transformation", a=1, b=1, c=1)
  translist <- transformList('FSC-H', asinhTrans) 
  dataTransform <- transform(samp, translist)
[Package flowCore version 1.52.1 Index]