filter-class {flowCore} | R Documentation |
The filter
class is the virtual base class for all filter/gating objects
in flowCore
. In general you will want to subclass or create a
more specific filter.
filterId
:filter
. This is typically user specified but can be
automatically deduced by certain filter operations, particularly
boolean and set operations.parameters
:%in%
logical
vector, a factor
vector or a numeric
vector of probabilities that the event is accepted by the
filter. Minimally, you must implement this method when creating a new
type of filter&
, |
, !
filter
class of a type
appropriate for handling the operation. These methods attempt to guess
an appropriate filterId
for the new filter
%subset%
, %\&%
\&
operation to compose the
two filters, though summary methods will use subset semantics when
calculating proportions. Additionally, when the filter is data driven,
such as norm2Filter
, the subset semantics are applied to the
data used to fit the filter possibly resulting in quite different, and
usually more desirable, results.%on%
transformList
to create a transformFilter
. This
filter is similar to the subset filter in that the filtering operation
takes place on transformed values rather than the original values.filter
%in%
, this method
returns a filterResult
object that can be used in
subsequent filter operations as well as providing more metadata about
the results of the filtering operationsummarizeFilter
filterDetails
slot of a
filterResult
. It is optional and typically only needs to be
implemented for data-driven filters.B. Ellis, P.D. Haaland and N. LeMeur