compareMatricesGen: Compare matrices

In stcolema/mdiHelpR: Helper Functions for Analysis of Sampling-Based Clustering Methods

Compare matrices

Description

Creates a plot with the heatmaps of matrices in a grid. There is an option to order the matrices based on the ordering imposed upon the first matrix given.

Usage

compareMatricesGen(
  ...,
  matrices = NULL,
  col_pal = NULL,
  breaks = NULL,
  order_rows = T,
  order_cols = T,
  n_row = NULL,
  n_col = NULL,
  method = "complete",
  distance = "euclidean",
  show_rownames = F,
  show_colnames = F,
  collect_legend = F,
  title = NULL
)

Arguments

...	A number of matrices.
matrices	If matrices are not given in “...“, a list of matrices to be heatmapped.
col_pal	The colour palette for the heatmaps. If a single vector of colours, then all heatmaps share the same colour palette, but the user may give a vector of palettes corresponding to each matrix passed to the function. If “NULL“, “,diHelpR::defineColPal“ is called.
breaks	Similarly to “col_pal“, a vector of breaks for the heatmaps, either a single vector to be used by all or else a list corresponding to the matrices passed to the function. Defaults to “mdiHelpR::defineDataBreaks(m1, col_pal)“ where “m1“ is the first matrix passed to the function.
order_rows	A logical instructing the function to order the rows of all matrices based upon the ordering imposed by hclust on the first.
order_cols	A vector of indices of the order of columns in the matrices. If “NULL“ then column order is taken from the first matrix given.
method	The linkage method used in imposing the ordering of rows and columns. Defaults to "complete".
distance	The distance measure used in imposing the ordering of rows and columns. Defaults to "euclidean".
show_rownames	A logical instructing inclusion of row names in the heatmaps (default is FALSE).
show_colnames	A logical instructing inclusion of column names in the heatmaps (default is FALSE).
collect_legend	Instruction to hide legend on all heatmaps and gather (assumed) common legend to the right of the plots.
title	The title of the final grid of plots.
col_names	A logical instructing inclusion of column names in the heatmaps (default is TRUE).
row_order	A vector of indices of the order of rows in the matrices. If “NULL“ then row order is taken from the first matrix given.

stcolema/mdiHelpR documentation built on July 28, 2024, 5:41 a.m.