gpoints-methods {flowViz} | R Documentation

## Adding points within a gate to a plot

### Description

These methods extend the basic graphics `points` methods for drawing of points contained within a `filter`. They allow for multiple dispatch, since not all `filter` types need to be evaluated for plotting, but this decision should be made internally. In any case, we need the raw data in the form of a `flowFrame`.

### Details

When plotting `flowFrame`s using the `plot` method provided by `flowViz`, the plotted parameters are recorded, which makes it possible to correctly overlay the points within `filter`s assuming that they are defined for the repective parameters. Warnings and error will be cast for the cases where the parameters are non-distinct or ambigious.

### Methods

x = "filter", data = "flowFrame", channels = "missing"
  General method for all objects inheriting from `filter`. This is used as the default when no more explicit method is found. It tries to find the plotted parameters from the internal `flowViz.state` environment. This only works if the flow data has been plotted using the `plot` methods provided by this `flowViz` package.
x = "filter", data = "missing", channels = "ANY"
  This gives a useful error message when we don't get what we need.
x = "filterResult", data = "flowFrame", channels = "character"
  We can get all the information about a `filter` from its `filterResult` without the need to re-evaluate.
x = "curv1Filter", data = "ANY"
  We either need a `filterResult` or the raw data as a `flowFrame` for `curv1Filter`s.
x = "curv1Filter", data = "flowFrame"
  see above
x = "curv1Filter", data = "missing"
  see above
x = "curv1Filter", data = "multipleFilterResult"
  see above
x = "curv2Filter", data = "ANY"
  We either need a `filterResult` or the raw data as a `flowFrame` for `curv2Filter`s.
x = "curv1Filter", data = "flowFrame", channels = "character"
  We evaluate the `filter` on the `flowFrame` and plot the subset of selected points. By default, every subpopulation (if there are any) is colored differently.
x = "curv2Filter", data = "flowFrame", channels = "character"
  see above
x = "kmeansFilter", data = "flowFrame", channels = "character"
  see above
x = "norm2Filter", data = "flowFrame", channels = "character"
  see above
x = "polygonGate", data = "flowFrame", channels = "character"
  see above
x = "quadGate", data = "flowFrame", channels = "character"
  see above
x = "rectangleGate", data = "flowFrame", channels = "character"
  see above

### Author(s)

F. Hahne

### See Also

`filter`, `flowFrame`, `glines`, `gpolygon`

[Package flowViz version 1.8.0 Index]