man/ComplexHeatmap-package.rd
d1da987e
 \name{ComplexHeatmap-package}
 \docType{package}
 \alias{ComplexHeatmap-package}
 \title{
6f1307c6
 Making complex heatmap
d1da987e
 }
 \description{
6f1307c6
 Making complex heatmap
d1da987e
 }
 \details{
6f1307c6
 This package aims to provide a simple and flexible way to arrange
 multiple heatmaps as well as self-defining annotation graphics.
7ab3fd24
 
2c7a2087
 The package is implemented in an object-oriented way. 
6f1307c6
 Components of heatmap lists are abstracted into several classes.
7ab3fd24
 
d1da987e
 \itemize{
   \item \code{\link{Heatmap-class}}: a single heatmap containing heatmap body, row/column names, titles, dendrograms and column annotations.
   \item \code{\link{HeatmapList-class}}: a list of heatmaps and row annotations.
   \item \code{\link{HeatmapAnnotation-class}}: a list of row annotations or column annotations.
 }
 
6f1307c6
 There are also several internal classes:
7ab3fd24
 
d1da987e
 \itemize{
   \item \code{\link{SingleAnnotation-class}}: a single row annotation or column annotation.
   \item \code{\link{ColorMapping-class}}: mapping from values to colors.
 }
 
6f1307c6
 For plotting one single heatmap, please go to the documentation page of \code{\link{Heatmap}}.
 For plotting multiple heatmaps, please go to \code{\link{HeatmapList-class}} and \code{+.AdditiveUnit}.
7ab3fd24
 
6f1307c6
 The vignette provides detailed explanation of how to use this package.
d1da987e
 }
12e85497
 \examples{
 # There is no example
 NULL
 
 }