MatrixFilterStates: 'FilterStates' subclass for matrices

In teal.slice: Filter Module for 'teal' Applications

FilterStates subclass for matrices

Description

Handles filter states in a matrix.

Super class

FilterStates -> MatrixFilterStates

Methods

Public methods

• MatrixFilterStates$new()

• MatrixFilterStates$clone()

Inherited methods

• FilterStates$clear_filter_states()
• FilterStates$destroy()
• FilterStates$format()
• FilterStates$get_call()
• FilterStates$get_filter_state()
• FilterStates$print()
• FilterStates$remove_filter_state()
• FilterStates$set_filter_state()
• FilterStates$srv_active()
• FilterStates$srv_add()
• FilterStates$ui_active()
• FilterStates$ui_add()

---

MatrixFilterStates$new()

Initialize MatrixFilterStates object.

Usage

MatrixFilterStates$new(
  data,
  data_reactive = function(sid = "") NULL,
  dataname,
  datalabel = NULL
)

Arguments

data

(matrix) the R object which subset function is applied on.

data_reactive

(⁠function(sid)⁠) should return a matrix object or NULL. This object is needed for the FilterState counts being updated on a change in filters. If function returns NULL then filtered counts are not shown. Function has to have sid argument being a character.

dataname

(character(1)) name of the data used in the subset expression. Passed to the function argument attached to this FilterStates.

datalabel

(character(1)) optional text label. Should be a name of experiment.

---

MatrixFilterStates$clone()

The objects of this class are cloneable with this method.

Usage

MatrixFilterStates$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

teal.slice documentation built on June 4, 2026, 5:07 p.m.