FilterMatrix-class

filterRules,FilterMatrix-method

[,FilterMatrix-method

cbind,FilterMatrix-method

rbind,FilterMatrix-method

FilterMatrix

show,FilterMatrix-method

summary,FilterMatrix-method

A <code>FilterMatrix</code> object is a matrix meant for storing
  the logical output of a set of <code>FilterRules</code>, where
  each rule corresponds to a column. The <code>FilterRules</code> are stored
  within the <code>FilterMatrix</code> object, for the sake of
  provenance. In general, a <code>FilterMatrix</code> behaves like an
  ordinary <code><a rd-options="" href="/link/matrix?package=S4Vectors&version=0.10.2" data-mini-rdoc="S4Vectors::matrix">matrix</a></code>.


classes

methods

The S4Vectors package defines the Vector and List virtual classes
and a set of generic functions that extend the semantic of ordinary
vectors and lists in R. Package developers can easily implement
vector-like or list-like objects as concrete subclasses of Vector or
List. In addition, a few low-level concrete subclasses of general
interest (e.g. DataFrame, Rle, and Hits) are implemented in the
S4Vectors package itself (many more are implemented in the IRanges
package and in other Bioconductor infrastructure packages).

Bioconductor Package Maintainer

S4Vectors

S4 implementation of vectors and lists

FilterMatrix-class function

In the code snippets below, <code>x</code> is a <code>FilterMatrix</code> object. <dl>
    <dt></dt><dd><code>filterRules(x)</code>: Get the <code>FilterRules</code>
      corresponding to the columns of the matrix.
    </dd> </dl> 

Accessor methods

<dl>
    <dt></dt><dd>
      <code>FilterMatrix(matrix, filterRules)</code>: Constructs a
      <code>FilterMatrix</code>, from a given <code>matrix</code> and
      <code>filterRules</code>. Not usually called by the user, see
      <code><a rd-options="" href="/link/evalSeparately?package=S4Vectors&version=0.10.2" data-mini-rdoc="S4Vectors::evalSeparately">evalSeparately</a></code>.
    </dd> </dl> 

Constructor

<dl>
    <dt></dt><dd>
      <code>summary(object, discarded = FALSE, percent = FALSE)</code>:
      Returns a numeric vector containing the total number of records
      (<code>nrow</code>), the number passed by each filter, and the number of
      records that passed every filter. If <code>discarded</code> is
      <code>TRUE</code>, then the numbers are inverted (i.e., the values are
      subtracted from the number of rows). If <code>percent</code> is
      <code>TRUE</code>, then the numbers are percent of total.
    </dd> </dl> 

Utilities

A <code>FilterMatrix</code> object is a matrix meant for storing
  the logical output of a set of <code>FilterRules</code>, where
  each rule corresponds to a column. The <code>FilterRules</code> are stored
  within the <code>FilterMatrix</code> object, for the sake of
  provenance. In general, a <code>FilterMatrix</code> behaves like an
  ordinary <code><a rd-options='' href='matrix'>matrix</a></code>.


FilterMatrix-class: Matrix for Filter Results

Description

Arguments

Accessor methods

Constructor

Utilities

See Also