Heat: Generates a heatmap from a table of data.

View source: R/heat.R

HeatR Documentation

Generates a heatmap from a table of data.

Description

This function wraps the Heatmap function in the rhtmlHeatmap package.

Usage

Heat(
  x,
  sort.rows = "None",
  sort.columns = "None",
  colors = c("#0066ff", "#ff0000"),
  standardization = "None",
  global.font.family = "Arial",
  global.font.color = "#000000",
  values.bounds.minimum = NULL,
  values.bounds.maximum = NULL,
  title = "",
  title.font.family = global.font.family,
  title.font.color = global.font.color,
  title.font.size = 16,
  subtitle = "",
  subtitle.font.family = global.font.family,
  subtitle.font.color = global.font.color,
  subtitle.font.size = 12,
  footer = "",
  footer.font.family = global.font.family,
  footer.font.color = global.font.color,
  footer.font.size = 12,
  x.title = "",
  x.title.font.family = global.font.family,
  x.title.font.color = global.font.color,
  x.title.font.size = 12,
  y.title = "",
  y.title.font.family = global.font.family,
  y.title.font.color = global.font.color,
  y.title.font.size = 12,
  x.tick.show = TRUE,
  x.tick.font.family = global.font.family,
  x.tick.font.color = global.font.color,
  x.tick.font.size = 10,
  y.tick.show = TRUE,
  y.tick.font.family = global.font.family,
  y.tick.font.color = global.font.color,
  y.tick.font.size = 10,
  legend.show = TRUE,
  legend.font.family = global.font.family,
  legend.font.color = global.font.color,
  legend.font.size = 10,
  data.label.show = TRUE,
  data.label.font.size = 10,
  data.label.font.family = global.font.family,
  data.label.format = "",
  data.label.prefix = "",
  data.label.suffix = "",
  hovertext.font.family = global.font.family,
  hovertext.font.size = 11,
  y.hovertext.format = data.label.format,
  y.hovertext.prefix = data.label.prefix,
  y.hovertext.suffix = data.label.suffix,
  left.columns = NULL,
  left.column.headings = "",
  right.columns = NULL,
  right.column.headings = ""
)

Arguments

x

A matrix of data to be displayed with values in the cells and optiona row and column labels.

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".

colors

A vector of 2 colors representing the maximum and minimum values.

standardization

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

global.font.family

Character; font family for all occurrences of any font attribute for the chart unless specified individually.

global.font.color

Global font color as a named color in character format (e.g. "black") or an rgb value (e.g. #' rgb(0, 0, 0, maxColorValue = 255)).

values.bounds.minimum

Numeric; lower bound of the color range.

values.bounds.maximum

Numeric; upper bound of the color range.

title

Character; chart title.

title.font.family

Character; title font family. Can be "Arial Black", "Arial", "Comic Sans MS", "Courier New", "Georgia", "Impact", "Lucida Console", "Lucida Sans Unicode", "Marlett", "Symbol", "Tahoma", "Times New Roman", "Trebuchet MS", "Verdana", "Webdings"

title.font.color

Title font color as a named color in character format (e.g. "black") or an rgb value (e.g. rgb(0, 0, 0, maxColorValue = 255)).

title.font.size

Integer; Title font size

subtitle

Character

subtitle.font.family

Character; subtitle font family

subtitle.font.color

subtitle font color as a named color in character format (e.g. "black") or an rgb value (e.g. rgb(0, 0, 0, maxColorValue = 255)).

subtitle.font.size

Integer; subtitle font size

footer

Character

footer.font.family

Character; footer font family

footer.font.color

footer font color as a named color in character format (e.g. "black") or an rgb value (e.g. rgb(0, 0, 0, maxColorValue = 255)).

footer.font.size

Integer; footer font size

x.title

Character, x-axis title

x.title.font.family

Character; x-axis title font family

x.title.font.color

x-axis title font color as a named color in character format (e.g. "black") or an rgb value (e.g. rgb(0, 0, 0, maxColorValue = 255)).

x.title.font.size

Integer; x-axis title font size

y.title

Character, y-axis title

y.title.font.family

Character; y-axis title font family

y.title.font.color

y-axis title font color as a named color in character format (e.g. "black") or an rgb value (e.g. rgb(0, 0, 0, max = 255)).

y.title.font.size

Integer; y-axis title font size

x.tick.show

Whether to display the x-axis tick labels

x.tick.font.family

Character; x-axis tick label font family

x.tick.font.color

X-axis tick label font color as a named color in character format (e.g. "black") or an rgb value (e.g. rgb(0, 0, 0, maxColorValue = 255)).

x.tick.font.size

Integer; x-axis tick label font size

y.tick.show

Whether to display the y-axis tick labels

y.tick.font.family

Character; y-axis tick label font family

y.tick.font.color

y-axis tick label font color as a named color in character format (e.g. "black") or an rgb value (e.g. rgb(0, 0, 0, maxColorValue = 255)).

y.tick.font.size

Integer; y-axis tick label font size

legend.show

Whether to display the legend

legend.font.family

Character; legend font family.

legend.font.color

Legend font color as a named color in character format (e.g. "black") or an rgb value (e.g. rgb(0, 0, 0, maxColorValue = 255)).

legend.font.size

Integer; Legend font size.

data.label.show

Whether to display the data values (note that they are always shown as hover text)

data.label.font.size

Integer; Font size for data label.

data.label.font.family

Character; font family for data label.

data.label.format

A string representing a d3 formatting code. See https://github.com/mbostock/d3/wiki/Formatting#numbers

data.label.prefix

Character; prefix for data values.

data.label.suffix

Character; suffix for data values.

hovertext.font.family

Character; font family for hovertext.

hovertext.font.size

Integer; Font size for hovertext (tooltips).

y.hovertext.format

A string representing a d3 formatting code. See https://github.com/mbostock/d3/wiki/Formatting#numbers

y.hovertext.prefix

Character; prefix for hovertext.

y.hovertext.suffix

Character; suffix for hovertext.

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.