d1da987e |
\name{Heatmap-class}
\docType{class}
\alias{Heatmap-class}
\title{
|
6f1307c6 |
Class for a single heatmap
|
d1da987e |
}
\description{
|
6f1307c6 |
Class for a single heatmap
|
d1da987e |
}
\details{
|
6f1307c6 |
The components for a single heamtap are placed into a 9 x 7 layout:
|
7ab3fd24 |
|
d1da987e |
\preformatted{
|
12e85497 |
+------+ (1)
|
d1da987e |
+------+ (2)
+------+ (3)
+------+ (4)
+-+-+-+------+-+-+-+
|1|2|3| 4(5) |5|6|7|
+-+-+-+------+-+-+-+
+------+ (6)
+------+ (7)
+------+ (8)
|
ba8a5070 |
+------+ (9) }
|
d1da987e |
|
6f1307c6 |
From top to bottom in column 4, the regions are:
|
7ab3fd24 |
|
d1da987e |
\itemize{
\item title which is put on the top of the heatmap, graphics are drawn by \code{\link{draw_title,Heatmap-method}}.
|
12e85497 |
\item column cluster on the top, graphics are drawn by \code{\link{draw_dend,Heatmap-method}}.
|
d1da987e |
\item column annotation on the top, graphics are drawn by \code{\link{draw_annotation,Heatmap-method}}.
\item column names on the top, graphics are drawn by \code{\link{draw_dimnames,Heatmap-method}}.
\item heatmap body, graphics are drawn by \code{\link{draw_heatmap_body,Heatmap-method}}.
\item column names on the bottom, graphics are drawn by \code{\link{draw_dimnames,Heatmap-method}}.
\item column annotation on the bottom, graphics are drawn by \code{\link{draw_annotation,Heatmap-method}}.
|
12e85497 |
\item column cluster on the bottom, graphics are drawn by \code{\link{draw_dend,Heatmap-method}}.
|
d1da987e |
\item title on the bottom, graphics are drawn by \code{\link{draw_title,Heatmap-method}}.
}
|
6f1307c6 |
From left to right in row 5, the regions are:
|
7ab3fd24 |
|
d1da987e |
\itemize{
\item title which is put in the left of the heatmap, graphics are drawn by \code{\link{draw_title,Heatmap-method}}.
|
12e85497 |
\item row cluster on the left, graphics are drawn by \code{\link{draw_dend,Heatmap-method}}.
|
d1da987e |
\item row names on the left, graphics are drawn by \code{\link{draw_dimnames,Heatmap-method}}.
\item heatmap body
\item row names on the right, graphics are drawn by \code{\link{draw_dimnames,Heatmap-method}}.
|
12e85497 |
\item row cluster on the right, graphics are drawn by \code{\link{draw_dend,Heatmap-method}}.
|
d1da987e |
\item title on the right, graphics are drawn by \code{\link{draw_title,Heatmap-method}}.
}
|
6f1307c6 |
The \code{\link{Heatmap-class}} is not responsible for heatmap legend and annotation legends. The \code{\link{draw,Heatmap-method}} method
will construct a \code{\link{HeatmapList-class}} object which only contains one single heatmap
and call \code{\link{draw,HeatmapList-method}} to make a complete heatmap.
|
d1da987e |
}
\section{Methods}{
|
6f1307c6 |
The \code{\link{Heatmap-class}} provides following methods:
|
7ab3fd24 |
|
d1da987e |
\itemize{
\item \code{\link{Heatmap}}: constructor method.
\item \code{\link{draw,Heatmap-method}}: draw a single heatmap.
\item \code{\link{add_heatmap,Heatmap-method}} append heatmaps and row annotations to a list of heatmaps.
|
378e5021 |
\item \code{\link{row_order,HeatmapList-method}}: get order of rows
\item \code{\link{column_order,HeatmapList-method}}: get order of columns
\item \code{\link{row_dend,HeatmapList-method}}: get row dendrograms
\item \code{\link{column_dend,HeatmapList-method}}: get column dendrograms
|
ba8a5070 |
}}
|
d1da987e |
\author{
|
6f1307c6 |
Zuguang Gu <z.gu@dkfz.de>
|
d1da987e |
}
\examples{
# for examples, please go to `Heatmap` method page
|
f597719b |
NULL
|
ba8a5070 |
|
f597719b |
}
|