cola_report-ConsensusPartitionList-method {cola}R Documentation

Make HTML report from the ConsensusPartitionList object

Description

Make HTML report from the ConsensusPartitionList object

Usage

## S4 method for signature 'ConsensusPartitionList'
cola_report(object, output_dir = getwd(), mc.cores = 1,
    title = "cola Report for Consensus Partitioning", env = parent.frame())

Arguments

object

A ConsensusPartitionList-class object.

output_dir

The output directory where the report is saved.

mc.cores

Multiple cores to use.

title

Title of the report.

env

Where the objects in the report are found, internally used.

Details

The ConsensusPartitionList-class object contains results for all top-value methods and all partition methods. This function generates a HTML report which contains all plots and tables for every combination of top-value method and partition method.

The report generation may take a while because it generates A LOT of heatmaps.

Examples of reports can be found at https://jokergoo.github.io/cola_examples/

Value

No value is returned.

Author(s)

Zuguang Gu <z.gu@dkfz.de>

Examples

## Not run: 
data(cola_rl)
cola_report(cola_rl[c("sd", "MAD"), c("hclust", "skmeans")], output_dir = "~/test_cola_cl_report")

## End(Not run)

[Package cola version 1.2.1 Index]