cola_report-HierarchicalPartition-method: Make HTML report from the HierarchicalPartition object

In cola: A Framework for Consensus Partitioning

Description

Make HTML report from the HierarchicalPartition object

Usage

## S4 method for signature 'HierarchicalPartition'
cola_report(object, output_dir = getwd(), mc.cores = 1,
    title = qq("cola Report for Hierarchical Partitioning (@{object[1]@top_value_method}:@{object[1]@partition_method})"),
    env = parent.frame())

Arguments

object	A HierarchicalPartition-class object.
output_dir	The output directory where the report is put.
mc.cores	Multiple cores to use.
title	Title of the report.
env	Where the objects in the report are found, internally used.

Details

This function generates a HTML report which contains all plots for all nodes in the partition hierarchy.

Value

No value is returned.

Author(s)

Zuguang Gu <[e-mail]>

Examples

if(FALSE) {
# the following code is runnable
data(golub_cola_rh)
cola_report(golub_cola_rh, output_dir = "~/test_cola_rh_report")
}

cola documentation built on Nov. 8, 2020, 8:12 p.m.