cola_report-HierarchicalPartition-method {cola} | R Documentation

## Make HTML report from the HierarchicalPartition object

### Description

Make HTML report from the HierarchicalPartition object

### Usage

    ## S4 method for signature 'HierarchicalPartition'
    cola_report(object, output_dir = getwd(), mc.cores = 1, cores = mc.cores,
        title = qq("cola Report for Hierarchical Partitioning"),
        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. This argument will be removed in future versions.
`cores` | Number of cores, or a `cluster` object returned by `makeCluster`.
`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 <z.gu@dkfz.de>

### Examples

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

[Package cola version 1.8.1 Index]