asinht-class: Class "asinht"

Description Objects from the Class Slots Extends Methods Note Author(s) References See Also Examples

Description

Inverse hyperbolic sin transformation is defined by the function

f(parameter,a,b)=sinh^{-1}(a*parameter)*b

Objects from the Class

Objects can be created by calls to the constructor asinht(parameter,a,b,transformationId)

Slots

.Data:

Object of class "function" ~~

a:

Object of class "numeric" -non zero constant

b:

Object of class "numeric" -non zero constant

parameters:

Object of class "transformation" -flow parameter to be transformed

transformationId:

Object of class "character" -unique ID to reference the transformation

Extends

Class "singleParameterTransform", directly. Class "transform", by class "singleParameterTransform", distance 2. Class "transformation", by class "singleParameterTransform", distance 3. Class "characterOrTransformation", by class "singleParameterTransform", distance 4.

Methods

No methods defined with class "asinht" in the signature.

Note

The inverse hyperbolic sin transformation object can be evaluated using the eval method by passing the data frame as an argument.The transformed parameters are returned as a matrix with a single column. (See example below)

Author(s)

Gopalakrishnan N, F.Hahne

References

Gating-ML Candidate Recommendation for Gating Description in Flow Cytometry V 1.5

See Also

sinht

Examples

1
2
3
 dat <- read.FCS(system.file("extdata","0877408774.B08",  package="flowCore"))
  asinh1<-asinht(parameters="FSC-H",a=2,b=1,transformationId="asinH1")
  transOut<-eval(asinh1)(exprs(dat))

flowCore documentation built on Sept. 21, 2018, 6:41 p.m.