ht_global_opt {ComplexHeatmap} | R Documentation |
Global graphic options for heatmaps
ht_global_opt(..., RESET = FALSE, READ.ONLY = NULL, LOCAL = FALSE, ADD = FALSE)
... |
options, see 'details' section |
RESET |
reset all the option values |
READ.ONLY |
|
LOCAL |
switch local mode |
ADD |
add new options |
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:
set row_names_gp
in Heatmap
.
set column_names_gp
in Heatmap
.
set row_title_gp
in Heatmap
.
set column_title_gp
in Heatmap
.
set title_gp
element in heatmap_legend_param
in Heatmap
.
set title_position
element in heatmap_legend_param
in Heatmap
.
set labels_gp
element in heatmap_legend_param
in Heatmap
.
set grid_width
element in heatmap_legend_param
in Heatmap
.
set grid_height
element in heatmap_legend_param
in Heatmap
.
set grid_border
element in heatmap_legend_param
in Heatmap
.
set title_gp
element in legend_param
in SingleAnnotation
.
set title_position
element in legend_param
in SingleAnnotation
.
set labels_gp
element in legend_param
in SingleAnnotation
.
set grid_width
element in legend_param
in SingleAnnotation
.
set grid_height
element in legend_param
in SingleAnnotation
.
set grid_border
element in legend_param
in SingleAnnotation
.
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)
Depends on the options users selected.
Zuguang Gu <z.gu@dkfz.de>
# no example for this function NULL