ruleOutliers,flowClust-method {flowClust} | R Documentation

## Showing or Modifying the Rule used to Identify Outliers

### Description

This method shows or modifies the rule used to identify outliers.

### Usage

    ruleOutliers(object)

    ## S4 method for signature 'flowClust'
    ruleOutliers(object)

    ## S4 method for signature 'flowClustList'
    ruleOutliers(object)

    ruleOutliers(object) <- value

    ## S4 replacement method for signature 'flowClust,list'
    ruleOutliers(object) <- value

### Arguments

`object` | Object returned from `flowClust` or `filter`.
`value` | A list object with one or more of the following named elements: `level`, `u.cutoff` and `z.cutoff`. Their interpretations are the same as those of the corresponding arguments in the `flowClust` function. Note that when both `level` and `u.cutoff` are missing, the rule set by the original value of `level` or `u.cutoff` will be unchanged rather than removed. Likewise, when `z.cutoff` is missing, the rule set by the original value of `z.cutoff` will be retained.

### Value

The replacement method modifies `object@ruleOutliers` (or `object[[k]]@ruleOutliers` if `object` is of class `flowClustList` or `tmixFilterResultList`) AND updates the logical vector `object@flagOutliers` (or `object[[k]]@ruleOutliers`) according to the new rule.

### Author(s)

Raphael Gottardo <raph@stat.ubc.ca>, Kenneth Lo <c.lo@stat.ubc.ca>

### References

Lo, K., Brinkman, R. R. and Gottardo, R. (2008) Automated Gating of Flow Cytometry Data via Robust Model-based Clustering. Cytometry A 73, 321-332.

### See Also

`flowClust`, `filter`

[Package flowClust version 3.26.0 Index]