-
Notifications
You must be signed in to change notification settings - Fork 231
/
Copy pathprepare-Heatmap-method.Rd
41 lines (36 loc) · 975 Bytes
/
prepare-Heatmap-method.Rd
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
34
35
36
37
38
39
40
41
\name{prepare-Heatmap-method}
\alias{prepare,Heatmap-method}
\alias{prepare}
\title{
Prepare the Heatmap
}
\description{
Prepare the Heatmap
}
\usage{
\S4method{prepare}{Heatmap}(object, process_rows = TRUE, process_columns = TRUE)
}
\arguments{
\item{object}{A \code{\link{Heatmap-class}} object.}
\item{process_rows}{Whether to process rows of the heatmap.}
\item{process_columns}{Whether to process columns of the heatmap.}
}
\details{
The preparation of the heatmap includes following steps:
\itemize{
\item making clustering on rows (by calling \code{\link{make_row_cluster,Heatmap-method}})
\item making clustering on columns (by calling \code{\link{make_column_cluster,Heatmap-method}})
\item making the layout of the heatmap (by calling \code{\link{make_layout,Heatmap-method}})
}
This function is only for internal use.
}
\value{
The \code{\link{Heatmap-class}} object.
}
\author{
Zuguang Gu <[email protected]>
}
\examples{
# There is no example
NULL
}