truncateTransform: Create the definition of a truncate transformation function...

View source: R/AllClasses.R

truncateTransformR Documentation

Create the definition of a truncate transformation function to be applied on a data set

Description

Create the definition of the truncate Transformation that will be applied on some parameter via the transform method. The definition of this function is currently x[x<a] <- a. Hence, all values less than a are replaced by a. The typical use would be to replace all values less than 1 by 1.

Usage

truncateTransform(transformationId="defaultTruncateTransform", a=1)

Arguments

transformationId

character string to identify the transformation

a

double that corresponds to the value at which to truncate

Value

Returns an object of class transform.

Author(s)

P. Haaland

See Also

transform-class, transform

Other Transform functions: arcsinhTransform(), biexponentialTransform(), inverseLogicleTransform(), linearTransform(), lnTransform(), logTransform(), logicleTransform(), quadraticTransform(), scaleTransform(), splitScaleTransform()

Examples


samp <- read.FCS(system.file("extdata",
   "0877408774.B08", package="flowCore"))
  truncateTrans <- truncateTransform(transformationId="Truncate-transformation", a=5)
  dataTransform <- transform(samp,transformList('FSC-H', truncateTrans))



RGLab/flowCore documentation built on March 19, 2024, 9:45 p.m.