File: draw-SingleAnnotation-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 (33 lines) | stat: -rw-r--r-- 909 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
33
\name{draw-SingleAnnotation-method}
\alias{draw,SingleAnnotation-method}
\title{
Draw the Single Annotation
}
\description{
Draw the Single Annotation
}
\usage{
\S4method{draw}{SingleAnnotation}(object, index, k = 1, n = 1, test = FALSE,
    anno_mark_param = list())
}
\arguments{

  \item{object}{A \code{\link{SingleAnnotation-class}} object.}
  \item{index}{A vector of indices.}
  \item{k}{The index of the slice.}
  \item{n}{Total number of slices. \code{k} and \code{n} are used to adjust annotation names. E.g. if \code{k} is 2 and \code{n} is 3, the annotation names are not drawn.}
  \item{test}{Is it in test mode? The value can be logical or a text which is plotted as the title of plot.}
  \item{anno_mark_param}{It contains specific parameters for drawing \code{\link{anno_mark}}.}

}
\value{
No value is returned.
}
\author{
Zuguang Gu <z.gu@dkfz.de>
}
\examples{
# There is no example
NULL

}