logtGml2_trans {flowWorkspace} | R Documentation

## Gating-ML 2.0 Log transformation.

### Description

Used to construct GML 2.0 flog transformer object.

### Usage

    logtGml2_trans(t = 262144, m = 4.5, n = 6, equal.space = FALSE)

### Arguments

`t` | top scale value
`m` | number of decades
`n` | desired number of breaks (the actual number will be different depending on the data range)
`equal.space` | whether breaks at equal-spaced intervals

### Details

GML 2.0 standard log transform function constructor. The definition is as in the GML 2.0 standard section 6.2 "parametrized logarithmic transformation – flog" This deviates from standard only in the following way. Before applying the logarithmic transformation, non-positive values are assigned the smallest positive value from the input rather than having undefined values (NA) under the transformation.

### Value

logtGml2 transformation object

### Examples

    trans.obj <- logtGml2_trans(t = 1e3, m = 1, equal.space = TRUE)
    data <- 1:1e3
    brks.func <- trans.obj[["breaks"]]
    brks <- brks.func(data)
    brks # fasinh space displayed at raw data scale

    #transform it to verify it is equal-spaced at transformed scale
    trans.func <- trans.obj[["transform"]]
    brks.trans <- trans.func(brks)
    brks.trans

[Package flowWorkspace version 4.2.0 Index]