File: add.AdditiveUnit.Rd

package info (click to toggle)
r-bioc-complexheatmap 2.14.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,632 kB
  • sloc: makefile: 5
file content (44 lines) | stat: -rw-r--r-- 1,252 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
\name{+.AdditiveUnit}
\alias{add.AdditiveUnit}
\alias{+.AdditiveUnit}
\title{
Horizontally Add Heatmaps or Annotations to a Heatmap List
}
\description{
Horizontally Add Heatmaps or Annotations to a Heatmap List
}
\usage{
\method{+}{AdditiveUnit}(x, y)
}
\arguments{

  \item{x}{A \code{\link{Heatmap-class}} object, a \code{\link{HeatmapAnnotation-class}} object or a \code{\link{HeatmapList-class}} object.}
  \item{y}{A \code{\link{Heatmap-class}} object, a \code{\link{HeatmapAnnotation-class}} object or a \code{\link{HeatmapList-class}} object.}

}
\details{
It is only a helper function. It actually calls
\code{\link{add_heatmap,Heatmap-method}}, \code{\link{add_heatmap,HeatmapList-method}} or
\code{\link{add_heatmap,HeatmapAnnotation-method}} depending on the class of the input
objects.

The \code{\link{HeatmapAnnotation-class}} object to be added should only be row
annotations. Column annotations should be added to the heatmap list by
\code{\link[=pct_v_pct]{\%v\%}}.

\code{x} and \code{y} can also be \code{NULL}.
}
\value{
A \code{\link{HeatmapList-class}} object.
}
\seealso{
\code{\link[=pct_v_pct]{\%v\%}} operator is used for vertical heatmap list.
}
\author{
Zuguang Gu <z.gu@dkfz.de>
}
\examples{
# There is no example
NULL

}