man/SingleAnnotation-class.rd
d1da987e
 \name{SingleAnnotation-class}
 \docType{class}
 \alias{SingleAnnotation-class}
 \title{
6f1307c6
 Class for a single annotation
d1da987e
 }
 \description{
6f1307c6
 Class for a single annotation
d1da987e
 }
 \details{
6f1307c6
 A complex heatmap always has more than one annotations on rows and columns. Here
 the \code{\link{SingleAnnotation-class}} defines the basic unit of annotations.
 The most simple annotation is one row or one column grids in which different colors
 represent different classes of the data. The annotation can also be more complex
 graphics, such as a boxplot that shows data distribution in corresponding row or column.
7ab3fd24
 
6f1307c6
 The \code{\link{SingleAnnotation-class}} is used for storing data for a single annotation and provides
 methods for drawing annotation graphics.
d1da987e
 }
 \section{Methods}{
6f1307c6
 The \code{\link{SingleAnnotation-class}} provides following methods:
7ab3fd24
 
d1da987e
 \itemize{
   \item \code{\link{SingleAnnotation}}: constructor method
   \item \code{\link{draw,SingleAnnotation-method}}: draw the single annotation.
ba8a5070
 }}
d1da987e
 \seealso{
6f1307c6
 The \code{\link{SingleAnnotation-class}} is always used internally. The public \code{\link{HeatmapAnnotation-class}}
 contains a list of \code{\link{SingleAnnotation-class}} objects and is used to add annotation graphics on heatmaps.
d1da987e
 }
 \author{
6f1307c6
 Zuguang Gu <z.gu@dkfz.de>
d1da987e
 }
 \examples{
 # for examples, please go to `SingleAnnotation` method page
f597719b
 NULL
ba8a5070
 
f597719b
 }