1 | 1 |
new file mode 100644 |
... | ... |
@@ -0,0 +1,25 @@ |
1 |
+\name{AnnotationFunction-class} |
|
2 |
+\docType{class} |
|
3 |
+\alias{AnnotationFunction-class} |
|
4 |
+\title{ |
|
5 |
+The AnnotationFunction Class |
|
6 |
+} |
|
7 |
+\description{ |
|
8 |
+The AnnotationFunction Class |
|
9 |
+} |
|
10 |
+\details{ |
|
11 |
+The heatmap annotation is basically graphics aligned to the heatmap columns or rows. |
|
12 |
+There is no restriction for the graphic types, e.g. it can be heatmap-like |
|
13 |
+annotation or points. Here the AnnotationFunction class is designed for |
|
14 |
+creating complex and flexible annotation graphics. As the main part of the class, it uses |
|
15 |
+a user-defined function to define the graphics. It also keeps information of |
|
16 |
+the size of the plotting regions of the annotation. And most importantly, it |
|
17 |
+allows subsetting to the annotation to draw a subset of the graphics, which |
|
18 |
+is the base for the splitting of the annotations. |
|
19 |
+ |
|
20 |
+See \code{\link{AnnotationFunction}} constructor for details. |
|
21 |
+} |
|
22 |
+\examples{ |
|
23 |
+# There is no example |
|
24 |
+NULL |
|
25 |
+} |