cocluster {blockcluster}

Co-Clustering function.

Description

This function performs Co-Clustering (simultaneous clustering of rows and columns ) for Binary, Contingency and Continuous data-sets using latent block models.It can also be used to perform semi-supervised co-clustering.

Usage

cocluster(
  data,
  datatype,
  semisupervised = FALSE,
  rowlabels = integer(0),
  collabels = integer(0),
  model = NULL,
  nbcocluster,
  strategy = coclusterStrategy(),
  nbCore = 1
)

Arguments

data

Input data as matrix (or list containing data matrix, numeric vector for row effects and numeric vector column effects in case of contingency data with known row and column effects.)

datatype

This is the type of data which can be "binary" , "contingency", "continuous" or "categorical".

semisupervised

Boolean value specifying whether to perform semi-supervised co-clustering or not. Make sure to provide row and/or column labels if specified value is true. The default value is false.

rowlabels

Integer Vector specifying the class of rows. The class number starts from zero. Provide -1 for unknown row class.

collabels

Integer Vector specifying the class of columns. The class number starts from zero. Provide -1 for unknown column class.

model

This is the name of model. The following models exists for various types of data:

Model	Data-type	Proportions	Dispersion/Variance
pik_rhol_epsilonkl(Default)	binary	unequal	unequal
pik_rhol_epsilon	binary	unequal	equal
pi_rho_epsilonkl	binary	equal	unequal
pi_rho_epsilon	binary	equal	equal
pik_rhol_sigma2kl(Default)	continuous	unequal	unequal
pik_rhol_sigma	continuous	unequal	equal
pi_rho_sigma2kl	continuous	equal	unequal
pi_rho_sigma2	continuous	equal	equal
pik_rhol_unknown(default)	contingency	unequal	N.A
pi_rho_unknown	contingency	equal	N.A
pik_rhol_known	contingency	unequal	N.A
pi_rho_known	contingency	equal	N.A
pik_rhol_multi	categorical	unequal	unequal
pi_rho_multi	categorical	equal	unequal

nbcocluster

Integer vector specifying the number of row and column clusters respectively.

strategy

Object of class strategy.

nbCore

number of thread to use (OpenMP must be available), 0 for all cores. Default value is 1.

Value

Return an object of BinaryOptions or ContingencyOptions or ContinuousOptions depending on whether the data-type is Binary, Contingency or Continuous respectively.

Examples

# Simple example with simulated binary data
#load data
data(binarydata)
#usage of cocluster function in its most simplest form
out<-cocluster(binarydata,datatype="binary",nbcocluster=c(2,3))
#Summarize the output results
summary(out)
#Plot the original and Co-clustered data 
plot(out)