moduleHeatmap: Heatmap for feature modules

Description Usage Arguments Value Examples

View source: R/StateHeatmap.R

Description

Renders a heatmap for selected feature modules. Cells are ordered from those with the lowest probability of the module on the left to the highest probability on the right. If more than one module is used, then cells will be ordered by the probabilities of the first module only. Features are ordered from those with the highest probability in the module on the top to the lowest probability on the bottom.

Usage

1
2
3
moduleHeatmap(counts, celda.mod, feature.module = 1, top.cells = 100,
  top.features = NULL, normalize = TRUE, scale.row = scale,
  show_featurenames = TRUE)

Arguments

counts

Integer matrix. Rows represent features and columns represent cells. This matrix should be the same as the one used to generate 'celda.mod'.

celda.mod

Celda object of class 'celda_G' or 'celda_CG'.

feature.module

Integer Vector. The feature module(s) to display. Multiple modules can be included in a vector.

top.cells

Integer. Number of cells with the highest and lowest probabilities for this module to include in the heatmap. For example, if 'top.cells' = 50, the 50 cells with the lowest probability and the 50 cells with the highest probability for that feature module will be included. If NULL, all cells will be plotted. Default 100.

top.features

Integer. Plot 'top.features' with the highest probability in the feature module. If NULL, plot all features in the module. Default NULL.

normalize

Logical. Whether to normalize the columns of 'counts'. Default TRUE.

scale.row

Character. Which function to use to scale each individual row. Set to NULL to disable. Occurs after normalization and log transformation. For example, 'scale' will Z-score transform each row. Default 'scale'.

show_featurenames

Logical. Wheter feature names should be displayed. Default TRUE.

Value

A list containing row and column dendrograms as well as a gtable for grob plotting

Examples

1

compbiomed/celda documentation built on May 25, 2019, 3:58 a.m.