HeatMap: Generates a heatmap from a table of data.

View source: R/deprecated-heatmap.R

HeatMapR Documentation

Generates a heatmap from a table of data.

Description

This function wraps the Heatmap function in the rhtmlHeatmap package and performs additional data preparation.

Usage

HeatMap(
  table,
  data.type = "Use an existing table",
  ignore.rows = "NET, Total, SUM",
  ignore.columns = "NET, Total, SUM",
  transpose = FALSE,
  sort.rows = "None",
  sort.columns = "None",
  color = "Blues",
  standardization = "None",
  show.cell.values = "Automatic",
  cell.decimals = 2,
  show.row.labels = "Yes",
  show.column.labels = "Yes",
  show.legend = TRUE,
  chart.title = "",
  x.axis.title = "",
  y.axis.title = "",
  font.family = "sans-serif",
  font.color = "#000000",
  title.font.size = 24,
  xaxis.title.font.size = 14,
  yaxis.title.font.size = 14,
  legend.font.size = 11,
  value.font.size = 11,
  axis.label.font.size = 11,
  left.columns = NULL,
  left.column.headings = "",
  right.columns = NULL,
  right.column.headings = ""
)

Arguments

table

A matrix of data to be displayed.

data.type

Whether table values are numeric or strings. Options are "Use an existing table" or "Type or paste data".

ignore.rows

A string of rows to ignore, delimited by commas.

ignore.columns

A string of rows to ignore, delimited by commas.

transpose

Whether to transpose the table. TRUE or FALSE.

sort.rows

Whether to sort rows by their averages or link as a dendrogram. Options are "None", "Sort by averages (ascending)", "Sort by averages (descending)" and "Dendrogram".

sort.columns

Whether to sort columns by their averages or link as a dendrogram. Options are "None", "Sort by averages (ascending)", "Sort by averages (descending)" and "Dendrogram".

color

Options are "Blues", "Reds", "Greens", "Greys", "Purples", "Oranges", "Heat", "Blues and reds" or "Greys and reds".

standardization

Whether to standardize the shading of rows or columns. Options are "None", "Standardize rows" and "Standardize columns".

show.cell.values

Whether to show values in cells. Options are "Yes", "No" or "Automatic" (<= 20 rows and <= 10 columns).

cell.decimals

The number of decimal points to use for formatting cell values.

show.row.labels

Whether to label the rows. "Yes" or "No".

show.column.labels

Whether to label the columns. "Yes" or "No".

show.legend

Whether to show the legend.

chart.title

Title of the chart.

x.axis.title

Title of the x-axis.

y.axis.title

Title of the y-axis.

font.family

Font family to be used for all titles, axes, labels and values.

font.color

Font color to be used for all titles, axes and labels.

title.font.size

Font size of the title.

xaxis.title.font.size

Font size of the x-axis title.

yaxis.title.font.size

Font size of the y-axis title.

legend.font.size

Font size of the legend.

value.font.size

Font size of the cell values and tooltips.

axis.label.font.size

Font size of the axis labels.

left.columns

An optional list of vectors or matrices to be appended to the left of the heatmap.

left.column.headings

An optional comma separated string containing headings for left.columns. If not supplied, colnames of the items in left.columns are used.

right.columns

An optional list of vectors or matrices to be appended to the right of the heatmap.

right.column.headings

An optional comma separated string containing headings for right.columns. If not supplied, colnames of the items in right.columns are used.


Displayr/flipStandardCharts documentation built on Feb. 26, 2024, 12:42 a.m.