ratio-class: Class "ratio"

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

Description

ratio transform calculates the ratio of two parameters defined by the function

f(parameter_1,parameter_2)=\frac{parameter_1}{parameter_2}

Objects from the Class

Objects can be created by calls to the constructor ratio(parameter1,parameter2,transformationId) .

Slots

.Data:

Object of class "function" ~~

numerator:

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

denominator:

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

transformationId:

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

Extends

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

Methods

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

Note

The ratio transformation object can be evaluated using the eval method by passing the data frame as an argument.The transformed parameters are returned as matrix with one 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

dg1polynomial,quadratic,squareroot

Examples

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

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