geom_th_title: The row or column title

In fionarhuang/TreeHeatmap: A package to plot heatmaps at different levels of a tree

The row or column title

Description

add the row or column title

Usage

geom_th_title(
  mapping = NULL,
  name = NULL,
  side = "left",
  nudge_x = 0,
  nudge_y = 0,
  na.rm = FALSE,
  show.legend = NA,
  inherit.aes = FALSE,
  ...
)

Arguments

mapping	Set of aesthetic mappings created by aes(). If specified and inherit.aes = TRUE (the default), it is combined with the default mapping at the top level of the plot. You must supply mapping if there is no plot mapping.
name	the name of the heatmap to add row or column labels.
side	a character value selected from left, right, top or bottom. left and right to add the row title; top or bottom to add the column title.
nudge_x	a value to shift the title horizontally.
nudge_y	a value to shift the title vertically.
na.rm	If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.
show.legend	logical. Should this layer be included in the legends? NA, the default, includes if any aesthetics are mapped. FALSE never includes, and TRUE always includes. It can also be a named logical vector to finely select the aesthetics to display.
inherit.aes	If FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from the default plot specification, e.g. borders().
...	Other arguments passed on to layer(). These are often aesthetics, used to set an aesthetic to a fixed value, like colour = "red" or size = 3. They may also be parameters to the paired geom/stat.

Value

geom layer

Author(s)

Ruizhu Huang

fionarhuang/TreeHeatmap documentation built on Feb. 1, 2024, 7:30 a.m.