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, mc.cores = 1, 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.

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.

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_rh)
cola_report(cola_rh, output_dir = "~/test_cola_rh_report")

## End(Not run)

[Package cola version 1.0.1 Index]