-
Notifications
You must be signed in to change notification settings - Fork 1
/
tidyheatmap.R
294 lines (269 loc) · 10.1 KB
/
tidyheatmap.R
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
#' Create heatmap from tidy data
#'
#' A tidyverse-style interface to the powerful heatmap package
#' [pheatmap](https://github.com/raivokolde/pheatmap).
#' It enables the convenient generation of complex heatmaps from tidy data.
#'
#' @param df A tidy dataframe in long format.
#'
#' @param rows,columns Column in the dataframe to use for heatmap `rows` and
#' `columns`.
#' @param values Column in the dataframe containing the values to be color coded
#' in the heatmap cells.
#'
#' @param colors Vector of colors used for the color legend.
#' @param color_legend_n Number of colors in the color legend.
#' @param color_legend_min,color_legend_max Min and max value of the color legend.
#' Values smaller then the `color_legend_min` will have the lowest color,
#' `values` bigger than the `color_legend_max` will get the highest color.
#' @param color_na Color to use for `NAs` in `values`.
#'
#' @param annotation_row,annotation_col Column(s) in the dataframe to use for
#' `row` and `column` annotation.
#' To use multiple columns for annotation combine then by `c(column1, column2)`.
#' @param gaps_row,gaps_col Column in the dataframe to use for use for `row` and
#' `column` gaps.
#' @inheritParams pheatmap::pheatmap
#'
#' @param show_selected_row_labels,show_selected_col_labels Only display a
#' subset of selected labels for `rows` and `columns`.
#' Provide selected labels as `c("label1", "label2")`.
#'
#' @return
#' Invisibly a `pheatmap` object that is a list with components
#' * `tree_row` the clustering of rows as `hclust` object
#' * `tree_col` the clustering of columns as `hclust` object
#' * `kmeans` the kmeans clustering of rows if parameter `kmeans_k` was specified
#' * `gtable` a `gtable` object containing the heatmap, can be used for combining
#' the heatmap with other plots
#' @export
#'
#' @examples
#' # Basic example
#' tidyheatmap(data_exprs,
#' rows = external_gene_name,
#' columns = sample,
#' values = expression,
#' scale = "row"
#' )
#'
#' # Change number of colors in color lengend
#' tidyheatmap(data_exprs,
#' rows = external_gene_name,
#' columns = sample,
#' values = expression,
#' scale = "row",
#' color_legend_n = 5
#' )
#'
#' # Change color in color legend
#' tidyheatmap(data_exprs,
#' rows = external_gene_name,
#' columns = sample,
#' values = expression,
#' scale = "row",
#' colors = c("#145afc","#ffffff","#ee4445")
#' )
#'
#' # Add row and column annotation
#' tidyheatmap(data_exprs,
#' rows = external_gene_name,
#' columns = sample,
#' values = expression,
#' scale = "row",
#' annotation_col = c(sample_type, condition, group),
#' annotation_row = c(is_immune_gene, direction)
#' )
#'
#' # Add gaps between rows and columns
#' tidyheatmap(data_exprs,
#' rows = external_gene_name,
#' columns = sample,
#' values = expression,
#' scale = "row",
#' annotation_col = c(sample_type, condition, group),
#' annotation_row = c(is_immune_gene, direction),
#' gaps_row = direction,
#' gaps_col = group
#' )
#'
tidyheatmap <- function(
df,
rows,
columns,
values,
colors = NA,
color_legend_n = 15,
color_legend_min = NA,
color_legend_max = NA,
color_na = "#DDDDDD",
annotation_row = NULL,
annotation_col = NULL,
gaps_row = NULL,
gaps_col = NULL,
show_selected_row_labels = NULL,
show_selected_col_labels = NULL,
filename = NA,
scale = "none",
fontsize = 7,
cellwidth = NA,
cellheight = NA,
cluster_rows = FALSE,
cluster_cols = FALSE,
border_color = NA,
kmeans_k = NA,
clustering_distance_rows = "euclidean",
clustering_distance_cols = "euclidean",
clustering_method = "complete",
clustering_callback = function(x, ...) { return(x) },
cutree_rows = NA,
cutree_cols = NA,
treeheight_row = ifelse((class(cluster_rows) == "hclust") || cluster_rows, 50, 0),
treeheight_col = ifelse((class(cluster_cols) == "hclust") || cluster_cols, 50, 0),
legend = TRUE,
legend_breaks = NA,
legend_labels = NA,
annotation_colors = NA,
annotation_legend = TRUE,
annotation_names_row = TRUE,
annotation_names_col = TRUE,
drop_levels = TRUE,
show_rownames = TRUE,
show_colnames = TRUE,
main = NA,
fontsize_row = fontsize,
fontsize_col = fontsize,
angle_col = c("270", "0", "45", "90", "315"),
display_numbers = FALSE,
number_format = "%.2f",
number_color = "grey30",
fontsize_number = 0.8 * fontsize,
width = NA,
height = NA,
silent = FALSE) {
if(missing(df)) stop("argument 'df' is missing, with no default")
if(missing(rows)) stop("argument 'rows' is missing, with no default")
if(missing(columns)) stop("argument 'columns' is missing, with no default")
if(missing(values)) stop("argument 'values' is missing, with no default")
heatmap_data <-
wrangle_data(df, {{ rows }}, {{ columns }}, {{ values }},
annotation_row = {{ annotation_row }},
annotation_col = {{ annotation_col }},
gaps_row = {{ gaps_row }},
gaps_col = {{ gaps_col }})
breaks <- NA
if (is.numeric(color_legend_min) & is.numeric(color_legend_max) & is.numeric(color_legend_n))
breaks <- seq(color_legend_min, color_legend_max, length.out = color_legend_n+1)
if (any(is.na(colors)))
colors <- rev(RColorBrewer::brewer.pal(n = 7, name ="RdYlBu"))
labels_row <- NULL
if (!is.null(show_selected_row_labels) & is.character(show_selected_row_labels)) {
labels_row = rownames(heatmap_data$m)
labels_row[!labels_row %in% show_selected_row_labels] = ""
}
labels_col <- NULL
if (!is.null(show_selected_col_labels) & is.character(show_selected_col_labels)) {
labels_col = colnames(heatmap_data$m)
labels_col[!labels_col %in% show_selected_col_labels] = ""
}
pheatmap::pheatmap(heatmap_data$m,
color = grDevices::colorRampPalette(colors)(color_legend_n),
breaks = breaks,
na_col = color_na,
annotation_row = heatmap_data$annotation_row,
annotation_col = heatmap_data$annotation_col,
gaps_row = heatmap_data$gaps_row,
gaps_col = heatmap_data$gaps_col,
labels_row = labels_row,
labels_col = labels_col,
filename = filename,
scale = scale,
fontsize = fontsize,
cellwidth = cellwidth,
cellheight = cellheight,
cluster_rows = cluster_rows,
cluster_cols = cluster_cols,
border_color = border_color,
kmeans_k = kmeans_k,
clustering_distance_rows = clustering_distance_rows,
clustering_distance_cols = clustering_distance_cols,
clustering_method = clustering_method,
clustering_callback = clustering_callback,
cutree_rows = cutree_rows,
cutree_cols = cutree_cols,
treeheight_row = treeheight_row,
treeheight_col = treeheight_col,
legend = legend,
legend_breaks = legend_breaks,
legend_labels = legend_labels,
annotation_colors = annotation_colors,
annotation_legend = annotation_legend,
annotation_names_row = annotation_names_row,
annotation_names_col = annotation_names_col,
drop_levels = drop_levels,
show_rownames = show_rownames,
show_colnames = show_colnames,
main = main,
fontsize_row = fontsize_row,
fontsize_col = fontsize_col,
angle_col = angle_col,
display_numbers = display_numbers,
number_format = number_format,
number_color = number_color,
fontsize_number = fontsize_number,
width = width,
height = height,
silent = silent)
}
#' @export
#' @rdname tidyheatmap
#' @usage NULL
tidy_heatmap <- tidyheatmap
globalVariables(".")
#' @importFrom dplyr %>%
bro_string_diff <- function(x) {
(x[-length(x)] != x[-1]) %>%
which(.)
}
wrangle_data <- function(df, rows, columns, values, annotation_row = NULL,
annotation_col = NULL, gaps_row = NULL, gaps_col = NULL) {
m <-
df %>%
dplyr::select({{ rows }}, {{ columns }}, {{ values }}) %>%
tidyr::pivot_wider(names_from = {{ columns }}, values_from = {{ values }}) %>%
tibble::column_to_rownames(colnames(.)[1])
if (!rlang::quo_is_null(rlang::enquo(annotation_col))) {
annotation_col <-
df %>%
dplyr::select({{ columns }}, {{ annotation_col }}) %>%
dplyr::distinct() %>%
tibble::column_to_rownames(colnames(.)[1])
} else annotation_col <- NA
if (!rlang::quo_is_null(rlang::enquo(annotation_row))) {
annotation_row <-
df %>%
dplyr::select({{ rows }}, {{ annotation_row }}) %>%
dplyr::distinct() %>%
tibble::column_to_rownames(colnames(.)[1])
} else {
annotation_row <- NA
}
if(!rlang::quo_is_null(rlang::enquo(gaps_row))) {
gaps_row <-
df %>%
dplyr::select({{ rows }}, {{ gaps_row }}) %>%
dplyr::distinct() %>%
dplyr::pull({{ gaps_row }}) %>%
bro_string_diff()
}
if(!rlang::quo_is_null(rlang::enquo(gaps_col))) {
gaps_col <-
df %>%
dplyr::select({{ columns }}, {{ gaps_col }}) %>%
dplyr::distinct() %>%
dplyr::pull({{ gaps_col }}) %>%
bro_string_diff()
}
list(m = m, annotation_row = annotation_row, annotation_col = annotation_col,
gaps_row = gaps_row, gaps_col = gaps_col)
}