getBiclustClusters: Extract a list of bicluster objects from a biclust object.

View source: R/extract_biclust.R

getBiclustClustersR Documentation

Extract a list of bicluster objects from a biclust object.

Description

Extract a list of bicluster objects from a biclust object.

Usage

getBiclustClusters(
  bics,
  mat,
  method = "biclust",
  transposed = FALSE,
  filterfun = NULL,
  ...
)

Arguments

bics

A biclust object.

mat

Original matrix, that was used for biclustering.

method

Name of the used biclustering algorithm. Should be one of the following: "biclust", "biclust-bimax", "biclust-cc", "biclust-plaid", "biclust-quest", "biclust-spectral", "biclust-xmotifs" or "biclust-qubic", "biclust-unibic".

transposed

True, if the bicluster calculation was performed on a tranposed matrix.

filterfun

A function to filter biclusters. Only if the function returns True, the bicluster is added to the returned list. The function has to accept a the bicluster (given as submatrix of mat) filterfun(bicluster_matrix, ...).

...

Other parameters forwarded to the filterfun.

Value

A list of bicluster objects, which have to be valid (See validate_bicluster.

Examples

m <- matrix(seq(1:16), nrow=4)
# m <- matrix(rnorm(10000), nrow=100)
# res <- biclust::biclust(m, method = biclust::BCBimax())
# getBiclustClusters(res, m)


tdrose/mosbi documentation built on May 4, 2022, 3:22 p.m.