d1da987e |
\name{make_layout-HeatmapList-method}
\alias{make_layout,HeatmapList-method}
\title{
|
3c40a7c1 |
Make Layout for the Heatmap List
|
d1da987e |
}
\description{
|
3c40a7c1 |
Make Layout for the Heatmap List
|
d1da987e |
}
\usage{
|
ad35494a |
\S4method{make_layout}{HeatmapList}(object,
row_title = character(0),
|
12e85497 |
row_title_side = c("left", "right"),
row_title_gp = gpar(fontsize = 14),
column_title = character(0),
column_title_side = c("top", "bottom"),
|
d1da987e |
column_title_gp = gpar(fontsize = 14),
|
ad35494a |
|
d1da987e |
heatmap_legend_side = c("right", "left", "bottom", "top"),
|
9487d939 |
merge_legends = FALSE,
|
12e85497 |
show_heatmap_legend = TRUE,
heatmap_legend_list = list(),
|
d1da987e |
annotation_legend_side = c("right", "left", "bottom", "top"),
|
12e85497 |
show_annotation_legend = TRUE,
annotation_legend_list = list(),
|
82c17797 |
align_heatmap_legend = NULL,
align_annotation_legend = NULL,
|
8b0c8512 |
legend_grouping = c("adjusted", "original"),
|
ad35494a |
ht_gap = unit(2, "mm"),
|
d1da987e |
main_heatmap = which(sapply(object@ht_list, inherits, "Heatmap"))[1],
|
1a56796e |
padding = GLOBAL_PADDING,
|
ad35494a |
|
1a56796e |
auto_adjust = TRUE,
|
12e85497 |
row_dend_side = c("original", "left", "right"),
|
55b56e3d |
row_sub_title_side = c("original", "left", "right"),
|
ad35494a |
column_dend_side = c("original", "top", "bottom"),
column_sub_title_side = c("original", "top", "bottom"),
row_gap = NULL,
|
55b56e3d |
cluster_rows = NULL,
|
bf60e9d4 |
cluster_row_slices = NULL,
|
55b56e3d |
clustering_distance_rows = NULL,
clustering_method_rows = NULL,
row_dend_width = NULL,
show_row_dend = NULL,
row_dend_reorder = NULL,
row_dend_gp = NULL,
row_order = NULL,
|
ad35494a |
row_km = NULL,
|
0d456ec7 |
row_km_repeats = NULL,
|
ad35494a |
row_split = NULL,
|
1a56796e |
height = NULL,
heatmap_height = NULL,
|
ad35494a |
column_gap = NULL,
cluster_columns = NULL,
|
bf60e9d4 |
cluster_column_slices = NULL,
|
ad35494a |
clustering_distance_columns = NULL,
clustering_method_columns = NULL,
column_dend_width = NULL,
show_column_dend = NULL,
column_dend_reorder = NULL,
column_dend_gp = NULL,
column_order = NULL,
column_km = NULL,
|
0d456ec7 |
column_km_repeats = NULL,
|
ad35494a |
column_split = NULL,
|
1a56796e |
width = NULL,
|
8054b16b |
heatmap_width = NULL,
use_raster = NULL,
raster_device = NULL,
raster_quality = NULL,
raster_device_param = NULL,
raster_resize = NULL)
|
ba8a5070 |
}
|
d1da987e |
\arguments{
|
3c40a7c1 |
\item{object}{A \code{\link{HeatmapList-class}} object.}
\item{row_title}{Title on the row.}
\item{row_title_side}{Will the title be put on the left or right of the heatmap list?}
\item{row_title_gp}{Graphic parameters for the row title.}
\item{column_title}{Title on the column.}
\item{column_title_side}{Will the title be put on the top or bottom of the heatmap?}
\item{column_title_gp}{Graphic parameters for the column title.}
\item{heatmap_legend_side}{Side of the heatmap legends.}
\item{merge_legends}{Whether to put heatmap legends and annotation legends together. By default they are put in different viewports.}
\item{show_heatmap_legend}{Whether show heatmap legends.}
|
7ba2bb40 |
\item{heatmap_legend_list}{A list of self-defined legends, should be wrapped into a list of \code{\link[grid:grid.grob]{grob}} objects. Normally they are constructed by \code{\link{Legend}}. }
|
3c40a7c1 |
\item{annotation_legend_side}{Side of annotation legends.}
\item{show_annotation_legend}{Whether show annotation legends.}
|
7ba2bb40 |
\item{annotation_legend_list}{A list of self-defined legends, should be wrapped into a list of \code{\link[grid:grid.grob]{grob}} objects. Normally they are constructed by \code{\link{Legend}}.}
|
82c17797 |
\item{align_heatmap_legend}{How to align the legends to heatmap. Possible values are "heatmap_center", "heatmap_top" and "global_center". If the value is \code{NULL}, it automatically picks the proper value from the three options.}
\item{align_annotation_legend}{How to align the legends to heatmap. Possible values are "heatmap_center", "heatmap_top" and "global_center".}
|
8b0c8512 |
\item{legend_grouping}{How the legends are grouped. Values should be "adjusted" or "original".}
|
3c40a7c1 |
\item{ht_gap}{Gap between heatmaps, should be a \code{\link[grid]{unit}} object. It can be a vector of length 1 or the number of heamtaps/annotations.}
\item{main_heatmap}{Name or index for the main heatmap.}
\item{padding}{Padding of the whole plot. The four values correspond to the bottom, left, top and right paddings.}
\item{auto_adjust}{whether apply automatic adjustment? The auto-adjustment includes turning off dendrograms, titles and row/columns for non-main heatmaps.}
\item{row_dend_side}{If auto-adjustment is on, to put the row dendrograms of the main heatmap to the most left side of the heatmap list or the most right side?}
\item{row_sub_title_side}{There can be sub titles generated by the splitting of heatmaps. Similar setting as \code{row_dend_side}.}
\item{column_dend_side}{Similar setting as \code{row_dend_side}.}
\item{column_sub_title_side}{Similar setting as \code{row_sub_title_side}.}
\item{row_gap}{Overwrite the corresponding setting in the main heatmap.}
\item{cluster_rows}{Overwrite the corresponding setting in the main heatmap.}
|
bf60e9d4 |
\item{cluster_row_slices}{Overwrite the corresponding setting in the main heatmap.}
|
3c40a7c1 |
\item{clustering_distance_rows}{Overwrite the corresponding setting in the main heatmap.}
\item{clustering_method_rows}{Overwrite the corresponding setting in the main heatmap.same setting as in \code{\link{Heatmap}}, if it is specified, \code{clustering_method_rows} in main heatmap is ignored.}
\item{row_dend_width}{Overwrite the corresponding setting in the main heatmap.}
\item{show_row_dend}{same Overwrite the corresponding setting in the main heatmap.}
\item{row_dend_reorder}{Overwrite the corresponding setting in the main heatmap.}
\item{row_dend_gp}{Overwrite the corresponding setting in the main heatmap.}
\item{row_order}{Overwrite the corresponding setting in the main heatmap.}
\item{row_km}{Overwrite the corresponding setting in the main heatmap.}
|
0d456ec7 |
\item{row_km_repeats}{Overwrite the corresponding setting in the main heatmap.}
|
3c40a7c1 |
\item{row_split}{Overwrite the corresponding setting in the main heatmap.}
\item{height}{Overwrite the corresponding setting in the main heatmap.}
\item{heatmap_height}{Overwrite the corresponding setting in the main heatmap.}
\item{column_gap}{Overwrite the corresponding setting in the main heatmap.}
\item{cluster_columns}{Overwrite the corresponding setting in the main heatmap.}
|
bf60e9d4 |
\item{cluster_column_slices}{Overwrite the corresponding setting in the main heatmap.}
|
3c40a7c1 |
\item{clustering_distance_columns}{Overwrite the corresponding setting in the main heatmap.}
\item{clustering_method_columns}{Overwrite the corresponding setting in the main heatmap.}
\item{column_dend_width}{column Overwrite the corresponding setting in the main heatmap.}
\item{show_column_dend}{Overwrite the corresponding setting in the main heatmap.}
\item{column_dend_reorder}{Overwrite the corresponding setting in the main heatmap.}
\item{column_dend_gp}{Overwrite the corresponding setting in the main heatmap.}
\item{column_order}{Overwrite the corresponding setting in the main heatmap.}
\item{column_km}{Overwrite the corresponding setting in the main heatmap.}
|
0d456ec7 |
\item{column_km_repeats}{Overwrite the corresponding setting in the main heatmap.}
|
3c40a7c1 |
\item{column_split}{Overwrite the corresponding setting in the main heatmap.}
\item{width}{Overwrite the corresponding setting in the main heatmap.}
\item{heatmap_width}{Overwrite the corresponding setting in the main heatmap.}
|
8054b16b |
\item{use_raster}{Overwrite the corresponding setting in every heatmap.}
\item{raster_device}{Overwrite the corresponding setting in every heatmap.}
\item{raster_quality}{Overwrite the corresponding setting in every heatmap.}
\item{raster_device_param}{Overwrite the corresponding setting in every heatmap.}
\item{raster_resize}{Overwrite the corresponding setting in every heatmap.}
|
ba8a5070 |
|
d1da987e |
}
\details{
|
1a56796e |
It sets the size of each component of the heatmap list and adjusts graphic
parameters for each heatmap if necessary.
|
7ab3fd24 |
|
6f1307c6 |
This function is only for internal use.
|
d1da987e |
}
\value{
|
3c40a7c1 |
A \code{\link{HeatmapList-class}} object in which settings for all heatmap are adjusted.
|
d1da987e |
}
\author{
|
6f1307c6 |
Zuguang Gu <z.gu@dkfz.de>
|
d1da987e |
}
\examples{
|
ad35494a |
# There is no example
|
f597719b |
NULL
|
c94e524a |
|
f597719b |
}
|