seurat_heat_highlight: Highlight parts of a heatmap

Description Usage Arguments Value

Description

Same as seurat_heat except that a selected part of the data is shown at a larger scale and the remainder a smaller scale

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
seurat_heat_highlight(
  x,
  select_cells,
  color_row,
  group.by,
  assay = "RNA",
  slot_data = "data",
  average = F,
  return_sep = F,
  row_scale = F,
  column_scale = F,
  color_scale = NULL,
  center_scale = T,
  show_quantile = 0.05,
  AP = NULL,
  seurat_heat_params = list()
)

Arguments

x

a Seurat object

select_cells

a logical vector specifying which part of x to magnify

average

average the expression across non highlighted cell types

return_sep

whether the highlighted or unhighlighted heatmaps will be returned as a list (TRUE) or as a ComplexHeatmapList (FALSE).

row_scale

whether to perform row scaling

color_scale

the scale of color gradient for heatmap. By default, the heatmap_color field of the list supplied to AP should define the color for min, middle and max of the dataset. Otherwise, please input a function created by circlize::colorRamp2

center_scale

whether to put white colors half way between the min and max of the matrix. Otherwise, white color is placed at value 0.

show_quantile

if supplied, then the color gradient would not extend over the entire range of the matrix. The default 0.05 means that color gradient would extend from 5% to 95% percentile. This is to avoid outliers skewing the dynamic range of colors.

AP

a list of aesthetic parameters. The important fields include cell_order for ordering group labels, gfont_fam, fontsize and heatmap_color

seurat_heat_params

a named list with names being the arguments to seurat_heat. Each item must only be a vector or list with length 1 or 2. If the length is 2, then the first value will be for the first (unhighlighted heatmap). The second will be for the highlighted heatmap.

Value

one or a list of ComplexHeatmaps


Yutong441/TBdev documentation built on Dec. 18, 2021, 8:22 p.m.