A FilterMatrix
object is a matrix meant for storing
the logical output of a set of FilterRules
, where
each rule corresponds to a column. The FilterRules
are stored
within the FilterMatrix
object, for the sake of
provenance. In general, a FilterMatrix
behaves like an
ordinary matrix
.
In the code snippets below, x
is a FilterMatrix
object.
filterRules(x)
: Get the FilterRules
corresponding to the columns of the matrix.
FilterMatrix(matrix, filterRules)
: Constructs a
FilterMatrix
, from a given matrix
and
filterRules
. Not usually called by the user, see
evalSeparately
.
summary(object, discarded = FALSE, percent = FALSE)
:
Returns a numeric vector containing the total number of records
(nrow
), the number passed by each filter, and the number of
records that passed every filter. If discarded
is
TRUE
, then the numbers are inverted (i.e., the values are
subtracted from the number of rows). If percent
is
TRUE
, then the numbers are percent of total.
Michael Lawrence
evalSeparately
is the typical way to generate this
object.
FilterRules objects.
Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.
All documentation is copyright its authors; we didn't write any of that.