Class "squareroot"

Description

Square root transform class defines a transformation defined by the function

f(parameter,a)= √{ |{\frac{parameter}{a}|}}

Objects from the Class

Objects can be created by calls to the constructor squareroot(parameters,a,transformationId)

Slots

.Data:

Object of class "function" ~~

a:

Object of class "numeric" -non zero multiplicative 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 "squareroot" in the signature.

Note

The squareroot transformation object can be evaluated using the eval method by passing the data frame as an argument.The transformed parameters are returned as a column vector. (See example below)

Author(s)

Gopalakrishnan N, F.Hahne

References

Gating-ML Candidate Recommendation for Gating Description in Flow Cytometry

See Also

dg1polynomial, ratio,quadratic

Examples

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

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.