setGate {flowPloidy} | R Documentation

## setGate

### Description

Apply a gate to a FlowHist object

### Usage

    setGate(fh, gate, refresh = TRUE)

    isGated(fh)

### Arguments

`fh` | a `FlowHist` object
`gate` | boolean, a vector indicating which rows in the raw data should be included (gated) in the analysis.
`refresh` | boolean, should the analysis be updated after applying the gate (default = TRUE)?

### Details

This function is primarily book-keeping to make sure that `histData` and downstream calculations are appropriately updated when a gate is applied. The code for applying the gate is actually in the function `setBins`.

### Value

`setGate` returns an updated `FlowHist` object, with the `histData` slot updated to account for the gate. With `refresh = TRUE` (default), it will also rebuild the model and complete the analysis.

`isGated` returns TRUE if the `FlowHist` object is gated.

### Author(s)

Tyler Smith

### See Also

`setBins`

[Package flowPloidy version 1.12.0 Index]