arcsinhTransform: Create the definition of an arcsinh transformation function...

Description Usage Arguments Value Author(s) See Also Examples

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

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

Arguments

transformationId

character string to identify the transformation

a

positive double that corresponds to the base of the logarithm.

b

positive double that corresponds to a scale factor.

c

positive double that corresponds to a scale factor

Value

Returns an object of class transform.

Author(s)

B. Ellis

See Also

transform-class, transform, asinh

Examples

1
2
3
4
5
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)


Search within the flowCore package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.