ht_global_opt {ComplexHeatmap}R Documentation

Global graphic options for heatmaps

Description

Global graphic options for heatmaps

Usage

ht_global_opt(..., RESET = FALSE, READ.ONLY = NULL, LOCAL = FALSE)

Arguments

...

options, see 'details' section

RESET

reset all the option values

READ.ONLY

TRUE means only to return read-only values, FALSE means only to return non-read-only values, NULL means to return both.

LOCAL

switch local mode

Details

You can set some parameters for all heatmaps/annotations simultaneously by this global function. Pleast note you should put it before your heatmap code and reset all option values after drawing the heatmaps to get rid of affecting next heatmap plotting.

There are following parameters:

heatmap_row_names_gp

set row_names_gp in Heatmap.

heatmap_column_names_gp

set column_names_gp in Heatmap.

heatmap_row_title_gp

set row_title_gp in Heatmap.

heatmap_column_title_gp

set column_title_gp in Heatmap.

heatmap_legend_title_gp

set title_gp element in heatmap_legend_param in Heatmap.

heatmap_legend_title_position

set title_position element in heatmap_legend_param in Heatmap.

heatmap_legend_labels_gp

set labels_gp element in heatmap_legend_param in Heatmap.

heatmap_legend_grid_width

set grid_width element in heatmap_legend_param in Heatmap.

heatmap_legend_grid_height

set grid_height element in heatmap_legend_param in Heatmap.

heatmap_legend_grid_border

set grid_border element in heatmap_legend_param in Heatmap.

heatmap_legend_title_gp

set title_gp element in legend_param in SingleAnnotation.

heatmap_legend_title_position

set title_position element in legend_param in SingleAnnotation.

heatmap_legend_labels_gp

set labels_gp element in legend_param in SingleAnnotation.

heatmap_legend_grid_width

set grid_width element in legend_param in SingleAnnotation.

heatmap_legend_grid_height

set grid_height element in legend_param in SingleAnnotation.

heatmap_legend_grid_border

set grid_border element in legend_param in SingleAnnotation.

fast_hclust

whether use hclust to speed up clustering?

You can get or set option values by the traditional way (like options) or by $ operator: 

    # to get option values
    ht_global_opt("heatmap_row_names_gp")
    ht_global_opt$heatmap_row_names_gp

    # to set option values
    ht_global_opt("heatmap_row_names_gp" = gpar(fontsize = 8))
    ht_global_opt$heatmap_row_names_gp = gpar(fontsize = 8)

Value

Depends on the options users selected.

Author(s)

Zuguang Gu <z.gu@dkfz.de>

Examples

# no example for this function
NULL
[Package ComplexHeatmap version 1.18.1 Index]