File: draw-AnnotationFunction-method.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 (32 lines) | stat: -rw-r--r-- 874 bytes parent folder | download | duplicates (3)
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
\name{draw-AnnotationFunction-method}
\alias{draw,AnnotationFunction-method}
\title{
Draw the AnnotationFunction Object
}
\description{
Draw the AnnotationFunction Object
}
\usage{
\S4method{draw}{AnnotationFunction}(object, index, k = 1, n = 1, test = FALSE, ...)
}
\arguments{

  \item{object}{The \code{\link{AnnotationFunction-class}} object.}
  \item{index}{Index of observations.}
  \item{k}{Current slice index.}
  \item{n}{Total number of slices.}
  \item{test}{Is it in test mode? The value can be logical or a text which is plotted as the title of plot.}
  \item{...}{Pass to \code{\link[grid]{viewport}}.}

}
\details{
Normally it is called internally by the \code{\link{SingleAnnotation-class}}.

When \code{test} is set to \code{TRUE}, the annotation graphic is directly drawn,
which is generally for testing purpose.
}
\examples{
# There is no example
NULL

}