cluster.module {DEComplexDisease} | R Documentation

## Predict the DEGs modules shared by patients

### Description

This function uses the output of `bi.deg` as input to predict the patient-DEG lists (or modules) shared by patients.

### Usage

    cluster.module(res.module, vote.seed = FALSE, model.method = NULL,
      cores = 1, max.show.n = 1, seed = 1)

### Arguments

`res.module` | a 'seed.module' object. It should be the output of `seed.module`
`vote.seed` | boolean, generate a generic seed or not
`model.method` | the method to find the breakpoint of bi-clustering. It is accepted value including 'slope.clustering', 'max.square', 'min.slope', 'min.similarity'. If it is NULL, its value will be get from res.module[['decd.input']][['module.method']]
`cores` | the thread number
`max.show.n` | the number of sub-modules to report
`seed` | a seed for random generator

### Details

The function is to cluster the modules predicted by `seed.module`, which is very useful when there are too many modules in 'res.module'.

This functon perform a k-mean based clustering to cluster the predicted modules. The patients within the same cluster are ranked based on their connecting degrees so that to find the representative patient(s). if 'vote.seed' is false, the bi-clustering analysis results of the representative patient will be used as the final results of the module. Otherwise, a generic seed will be generated by a voting method and the final results is predicted by bi-clustering analysis using the new seed.

### Value

A cluster.module object. It has two keys with prefix of 'decd':

'decd.input', the input information, including binary DEG matrix, used.genes and other parameter setting.

'decd.clustering', the clustering and the representative patient information.

Other keys has a prefix of 'M', which indicates clustered modules. Each module have several keys:

'curve', the patient-gene number during bi-clustering analysis;

'max.genes', the patient and genes when 'min.patients' is observed in bi-clustering analysis;

'max.patients', the patient and genes when 'min.genes' is reached in bi-clustering analysis';

'model', the patient and genes at the breakpoint of the 'curve';

'genes.removed', the ordered genes that are removed from module during bi-clustering analysis;

'patients.added', the ordered patients that are added to module during bi-clustering analysis

### Author(s)

Guofeng Meng

### Examples

    cluster.mod <- cluster.module(seed.mod, model.method='slope.clustering')
    cluster.mod2 <- cluster.module(seed.mod, model.method='slope.clustering', vote.seed=TRUE)

[Package DEComplexDisease version 1.6.0 Index]