R/shiny-widget.R
In jokergoo/InteractiveComplexHeatmap: Make Interactive Complex Heatmaps
Defines functions
InteractiveComplexHeatmapWidget
InteractiveComplexHeatmapModal
Documented in
InteractiveComplexHeatmapModal
InteractiveComplexHeatmapWidget
# == title
# Interactive complex heatmap modal dialog
#
# == param
# -input Passed from the Shiny server function.
# -output Passed from the Shiny server function.
# -session Passed from the Shiny server function.
# -ht_list A `ComplexHeatmap::Heatmap-class` or a `ComplexHeatmap::HeatmapList-class` object.
# -heatmap_id ID of the plot. If it is not specified, an internal ID is assigned.
# -title1 Pass to `InteractiveComplexHeatmapOutput`.
# -title2 Pass to `InteractiveComplexHeatmapOutput`.
# -width1 Pass to `InteractiveComplexHeatmapOutput`.
# -height1 Pass to `InteractiveComplexHeatmapOutput`.
# -width2 Pass to `InteractiveComplexHeatmapOutput`.
# -height2 Pass to `InteractiveComplexHeatmapOutput`.
# -width3 Pass to `InteractiveComplexHeatmapOutput`.
# -layout Pass to `InteractiveComplexHeatmapOutput`.
# -compact Pass to `InteractiveComplexHeatmapOutput`.
# -action Pass to `InteractiveComplexHeatmapOutput`.
# -cursor Pass to `InteractiveComplexHeatmapOutput`.
# -response Pass to `InteractiveComplexHeatmapOutput`.
# -brush_opt Pass to `InteractiveComplexHeatmapOutput`.
# -output_ui Pass to `InteractiveComplexHeatmapOutput`.
# -output_ui_float Pass to `InteractiveComplexHeatmapOutput`.
# -click_action Pass to `makeInteractiveComplexHeatmap`.
# -brush_action Pass to `makeInteractiveComplexHeatmap`.
# -js_code Additional JavaScript code that is put after the interactive heatmap UI. The value can be a text or a function
# that takes "heatmap ID" as the argument and returns the formatted JavaScript code.
# -close_button Whether to add a close button at the end of the widget. If it is ``FALSE``, the widget
# can be closed by clicking outside of the widget.
# -cancel_action Whether to remove the UI from HTML or just hide it when the UI is closed.
#
# == details
# It creates an interactive heatmap "modal dialog" according to a certain action.
#
# The function is normally put inside `shiny::observe` or `shiny::observeEvent`.
#
# == value
# No value is returned.
#
# == example
# if(interactive()) {
# require(ComplexHeatmap)
#
# ui = fluidPage(
# actionButton("show_heatmap", "Generate_heatmap"),
# )
#
# server = function(input, output, session) {
# m = matrix(rnorm(100), 10)
# ht = Heatmap(m)
#
# observeEvent(input$show_heatmap, {
# InteractiveComplexHeatmapModal(input, output, session, ht)
# })
# }
# shiny::shinyApp(ui, server)
# }
InteractiveComplexHeatmapModal = function(
input, output, session, ht_list, heatmap_id = NULL,
# parameters passed to InteractiveComplexHeatmapOutput()
title1 = "Original heatmap", title2 = "Selected sub-heatmap",
width1 = ifelse(layout == "1|(2-3)", 800, 450),
height1 = ifelse(layout == "1-(2|3)", 700, 350),
width2 = 370,
height2 = 350,
width3 = ifelse(layout == "(1-2)|3", 800, 370),
layout = ifelse("brush" %in% response, "(1-2)|3", "1-3"), compact = FALSE,
action = "click", cursor = TRUE, response = c(action, "brush"),
brush_opt = list(stroke = "#f00", opacity = 0.6),
output_ui = TRUE, output_ui_float = FALSE,
# parameters passed to makeInteractiveComplexHeatmap()
click_action = NULL, brush_action = NULL,
# other configurations
js_code = "", close_button = TRUE, cancel_action = c("remove", "hide")
) {
if(is.null(heatmap_id)) {
increase_widget_index()
heatmap_id = paste0("ht", get_widget_index())
}
heatmap_id = validate_heatmap_id(heatmap_id)
insertUI(selector = qq("body"),
where = "beforeEnd",
ui = htmlOutput(qq("@{heatmap_id}_heatmap_modal_ui")))
if(is.function(js_code)) js_code = js_code(heatmap_id)
js_code = paste(js_code, collapse = "\n")
cancel_action = match.arg(cancel_action)[1]
output[[qq("@{heatmap_id}_heatmap_modal_ui")]] = renderUI({
div(id = qq("@{heatmap_id}_heatmap_modal_background"),
div(id = qq("@{heatmap_id}_heatmap_modal"),
class = "heatmap_modal",
span(id = qq("@{heatmap_id}_heatmap_modal_close_icon"),
HTML("<i class='fa fa-times'></i>")
),
InteractiveComplexHeatmapOutput(heatmap_id = heatmap_id, title1 = title1, title2 = title2,
width1 = width1, height1 = height1, width2 = width2, height2 = height2, width3 = width3, layout = layout, compact = compact,
action = action, cursor = cursor, response = response, brush_opt = brush_opt, output_ui = output_ui, output_ui_float = output_ui_float,
internal = TRUE),
if(close_button) {
tagList(
tags$hr(),
tags$button("Close widget", id = qq("@{heatmap_id}_heatmap_modal_close"), class="btn btn-default")
)
} else {
NULL
},
tags$script(qq("
Shiny.setInputValue('@{heatmap_id}_heatmap_modal_open', Math.random());
"))
),
tags$style(HTML(qq("
#@{heatmap_id}_heatmap_modal_background {
left: 0;
right: 0;
top: 0;
bottom: 0;
position: fixed;
background-color: rgb(0, 0, 0, 0.5);
overflow-y: auto;
}
#@{heatmap_id}_heatmap_modal {
position: relative;
margin: 50px;
padding: 20px;
background-color: #fff;
background-clip: padding-box;
transition: opacity .15s linear;
box-shadow: 0 5px 15px rgba(0,0,0,.25);
border: 1px solid rgba(0,0,0,.2);
border-radius: 6px;
outline: 0;
}
#@{heatmap_id}_heatmap_modal_close_icon {
position: relative;
left: -10px;
top: -15px;
font-size: 1.5em;
background-color: white;
color: black;
}
#@{heatmap_id}_heatmap_modal_close_icon:hover {
cursor: pointer;
}
"))),
if(close_button) {
tags$script(HTML(qq("
$('#@{heatmap_id}_heatmap_modal_close').click(function() {
if('@{cancel_action}' == 'remove') {
Shiny.setInputValue('@{heatmap_id}_heatmap_modal_remove', Math.random());
$('#@{heatmap_id}_heatmap_modal_ui').remove();
} else {
$('#@{heatmap_id}_heatmap_modal_background').@{cancel_action}();
}
});
@{js_code}
")))
} else {
tags$script(HTML(qq("
$(document).mouseup(function(e) {
var container = $('#@{heatmap_id}_heatmap_modal');
if(!container.is(e.target) && container.has(e.target).length === 0 && $('.heatmap_modal').length == 1) {
$('#@{heatmap_id}_heatmap_modal_background').@{cancel_action}();
if('@{cancel_action}' == 'remove') {
Shiny.setInputValue('@{heatmap_id}_heatmap_modal_remove', Math.random());
$('#@{heatmap_id}_heatmap_modal_ui').remove();
}
}
});
@{js_code}
")))
},
tags$script(HTML(qq("
$('#@{heatmap_id}_heatmap_modal_close_icon').click(function() {
if('@{cancel_action}' == 'remove') {
Shiny.setInputValue('@{heatmap_id}_heatmap_modal_remove', Math.random());
$('#@{heatmap_id}_heatmap_modal_ui').remove();
} else {
$('#@{heatmap_id}_heatmap_modal_background').@{cancel_action}();
}
})
// code for pickr
// when parent element has 'position:fixed', the color picker is not correctly positioned
// following code manually adjust the positions of the color picker
$($('#@{heatmap_id}_heatmap_control ul li')[1]).click(function() {
var @{heatmap_id}_color_picker_buttons = $('#@{heatmap_id}_tabs-brush button.pcr-button');
$(@{heatmap_id}_color_picker_buttons[0]).click(function() {
var offset = $(@{heatmap_id}_color_picker_buttons[0]).offset();
var w = $(@{heatmap_id}_color_picker_buttons[0]).outerWidth();
var h = $(@{heatmap_id}_color_picker_buttons[0]).outerHeight();
$('#@{heatmap_id}_tabs-brush .pcr-app.visible').css('top', offset.top + h + 5).
css('left', offset.left);
})
$(@{heatmap_id}_color_picker_buttons[1]).click(function() {
var offset = $(@{heatmap_id}_color_picker_buttons[1]).offset();
var w = $(@{heatmap_id}_color_picker_buttons[1]).outerWidth();
var h = $(@{heatmap_id}_color_picker_buttons[1]).outerHeight();
$('#@{heatmap_id}_tabs-brush .pcr-app.visible').css('top', offset.top + h + 5).
css('left', offset.left);
})
})
")))
)
})
observeEvent(input[[qq("@{heatmap_id}_heatmap_modal_open")]], {
makeInteractiveComplexHeatmap(input, output, session, ht_list, heatmap_id = heatmap_id,
click_action = click_action, brush_action = brush_action)
}, once = TRUE)
observeEvent(input[[qq("@{heatmap_id}_heatmap_modal_remove")]], {
removeUI(qq("#@{heatmap_id}_heatmap_modal_background"))
})
}
# == title
# Interactive complex heatmap widget
#
# == param
# -input Passed from the Shiny server function.
# -output Passed from the Shiny server function.
# -session Passed from the Shiny server function.
# -ht_list A `ComplexHeatmap::Heatmap-class` or a `ComplexHeatmap::HeatmapList-class` object.
# -heatmap_id ID of the plot. If it is not specified, an internal ID is assigned.
# -output_id Where the heatmap is put.
# -title1 Pass to `InteractiveComplexHeatmapOutput`.
# -title2 Pass to `InteractiveComplexHeatmapOutput`.
# -width1 Pass to `InteractiveComplexHeatmapOutput`.
# -height1 Pass to `InteractiveComplexHeatmapOutput`.
# -width2 Pass to `InteractiveComplexHeatmapOutput`.
# -height2 Pass to `InteractiveComplexHeatmapOutput`.
# -width3 Pass to `InteractiveComplexHeatmapOutput`.
# -layout Pass to `InteractiveComplexHeatmapOutput`.
# -compact Pass to `InteractiveComplexHeatmapOutput`.
# -action Pass to `InteractiveComplexHeatmapOutput`.
# -cursor Pass to `InteractiveComplexHeatmapOutput`.
# -response Pass to `InteractiveComplexHeatmapOutput`.
# -brush_opt Pass to `InteractiveComplexHeatmapOutput`.
# -output_ui Pass to `InteractiveComplexHeatmapOutput`.
# -output_ui_float Pass to `InteractiveComplexHeatmapOutput`.
# -click_action Pass to `makeInteractiveComplexHeatmap`.
# -brush_action Pass to `makeInteractiveComplexHeatmap`.
# -js_code Additional JavaScript code that is put after the interactive heatmap UI. The value can be a text or a function
# that takes "heatmap ID" as the argument and returns the formatted JavaScript code.
# -close_button Whether to add a close button at the end of the widget.
# -cancel_action Whether to remove the UI from HTML or just hide it when the UI is closed.
#
# == details
# It creates an interactive heatmap widget according to a certain action. The UI is placed to the output ID that user defined.
#
# The function is normally put inside `shiny::observe` or `shiny::observeEvent`.
#
# == value
# No value is returned.
#
# == example
# if(interactive()) {
# require(ComplexHeatmap)
#
# ui = fluidPage(
# actionButton("show_heatmap", "Generate_heatmap"),
# htmlOutput("heatmap_output")
# )
#
# server = function(input, output, session) {
# m = matrix(rnorm(100), 10)
# ht = Heatmap(m)
#
# observeEvent(input$show_heatmap, {
# InteractiveComplexHeatmapWidget(input, output, session, ht,
# output_id = "heatmap_output")
# })
# }
# shiny::shinyApp(ui, server)
# }
InteractiveComplexHeatmapWidget = function(
input, output, session, ht_list, heatmap_id = NULL, output_id,
# parameters passed to InteractiveComplexHeatmapOutput()
title1 = "Original heatmap", title2 = "Selected sub-heatmap",
width1 = ifelse(layout == "1|(2-3)", 800, 450),
height1 = ifelse(layout == "1-(2|3)", 700, 350),
width2 = 370,
height2 = 350,
width3 = ifelse(layout == "(1-2)|3", 800, 370),
layout = ifelse("brush" %in% response, "(1-2)|3", "1-3"), compact = FALSE,
action = "click", cursor = TRUE, response = c(action, "brush"),
brush_opt = list(stroke = "#f00", opacity = 0.6),
output_ui = TRUE, output_ui_float = FALSE,
# parameters passed to makeInteractiveComplexHeatmap()
click_action = NULL, brush_action = NULL,
# other configurations
js_code = "", close_button = TRUE, cancel_action = c("remove", "hide")
) {
if(is.null(heatmap_id)) {
increase_widget_index()
heatmap_id = paste0("ht", get_widget_index())
}
heatmap_id = validate_heatmap_id(heatmap_id)
if(is.function(js_code)) js_code = js_code(heatmap_id)
js_code = paste(js_code, collapse = "\n")
cancel_action = match.arg(cancel_action)[1]
output[[output_id]] = renderUI({
div(id = qq("@{heatmap_id}_heatmap_widget"),
InteractiveComplexHeatmapOutput(heatmap_id = heatmap_id, title1 = title1, title2 = title2,
width1 = width1, height1 = height1, width2 = width2, height2 = height2, width3 = width3, layout = layout, compact = compact,
action = action, cursor = cursor, response = response, brush_opt = brush_opt, output_ui = output_ui, output_ui_float = output_ui_float,
internal = TRUE),
if(close_button) {
tagList(
tags$hr(),
tags$button("Close widget", id = qq("@{heatmap_id}_heatmap_widget_close"),
class = "btn btn-default"),
tags$script(HTML(qq("
$('#@{heatmap_id}_heatmap_widget_close').click(function() {
$('#@{heatmap_id}_heatmap_widget').@{cancel_action}();
if('@{cancel_action}' == 'remove') {
Shiny.setInputValue('@{heatmap_id}_heatmap_widget_remove', Math.random());
}
})
")))
)
} else {
NULL
},
tags$script(qq("
Shiny.setInputValue('@{heatmap_id}_heatmap_widget_open', Math.random());
@{js_code}
"))
)
})
observeEvent(input[[qq("@{heatmap_id}_heatmap_widget_open")]], {
makeInteractiveComplexHeatmap(input, output, session, ht_list, heatmap_id = heatmap_id,
click_action = click_action, brush_action = brush_action)
})
observeEvent(input[[qq("@{heatmap_id}_heatmap_widget_remove")]], {
removeUI(qq("#@{heatmap_id}_widget"))
})
}
jokergoo/InteractiveComplexHeatmap documentation built on Feb. 28, 2024, 7:34 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Defines functions InteractiveComplexHeatmapWidget InteractiveComplexHeatmapModal
Documented in InteractiveComplexHeatmapModal InteractiveComplexHeatmapWidget
# == title
# Interactive complex heatmap modal dialog
#
# == param
# -input Passed from the Shiny server function.
# -output Passed from the Shiny server function.
# -session Passed from the Shiny server function.
# -ht_list A `ComplexHeatmap::Heatmap-class` or a `ComplexHeatmap::HeatmapList-class` object.
# -heatmap_id ID of the plot. If it is not specified, an internal ID is assigned.
# -title1 Pass to `InteractiveComplexHeatmapOutput`.
# -title2 Pass to `InteractiveComplexHeatmapOutput`.
# -width1 Pass to `InteractiveComplexHeatmapOutput`.
# -height1 Pass to `InteractiveComplexHeatmapOutput`.
# -width2 Pass to `InteractiveComplexHeatmapOutput`.
# -height2 Pass to `InteractiveComplexHeatmapOutput`.
# -width3 Pass to `InteractiveComplexHeatmapOutput`.
# -layout Pass to `InteractiveComplexHeatmapOutput`.
# -compact Pass to `InteractiveComplexHeatmapOutput`.
# -action Pass to `InteractiveComplexHeatmapOutput`.
# -cursor Pass to `InteractiveComplexHeatmapOutput`.
# -response Pass to `InteractiveComplexHeatmapOutput`.
# -brush_opt Pass to `InteractiveComplexHeatmapOutput`.
# -output_ui Pass to `InteractiveComplexHeatmapOutput`.
# -output_ui_float Pass to `InteractiveComplexHeatmapOutput`.
# -click_action Pass to `makeInteractiveComplexHeatmap`.
# -brush_action Pass to `makeInteractiveComplexHeatmap`.
# -js_code Additional JavaScript code that is put after the interactive heatmap UI. The value can be a text or a function
# that takes "heatmap ID" as the argument and returns the formatted JavaScript code.
# -close_button Whether to add a close button at the end of the widget. If it is ``FALSE``, the widget
# can be closed by clicking outside of the widget.
# -cancel_action Whether to remove the UI from HTML or just hide it when the UI is closed.
#
# == details
# It creates an interactive heatmap "modal dialog" according to a certain action.
#
# The function is normally put inside `shiny::observe` or `shiny::observeEvent`.
#
# == value
# No value is returned.
#
# == example
# if(interactive()) {
# require(ComplexHeatmap)
#
# ui = fluidPage(
# actionButton("show_heatmap", "Generate_heatmap"),
# )
#
# server = function(input, output, session) {
# m = matrix(rnorm(100), 10)
# ht = Heatmap(m)
#
# observeEvent(input$show_heatmap, {
# InteractiveComplexHeatmapModal(input, output, session, ht)
# })
# }
# shiny::shinyApp(ui, server)
# }
InteractiveComplexHeatmapModal = function(
input, output, session, ht_list, heatmap_id = NULL,
# parameters passed to InteractiveComplexHeatmapOutput()
title1 = "Original heatmap", title2 = "Selected sub-heatmap",
width1 = ifelse(layout == "1|(2-3)", 800, 450),
height1 = ifelse(layout == "1-(2|3)", 700, 350),
width2 = 370,
height2 = 350,
width3 = ifelse(layout == "(1-2)|3", 800, 370),
layout = ifelse("brush" %in% response, "(1-2)|3", "1-3"), compact = FALSE,
action = "click", cursor = TRUE, response = c(action, "brush"),
brush_opt = list(stroke = "#f00", opacity = 0.6),
output_ui = TRUE, output_ui_float = FALSE,
# parameters passed to makeInteractiveComplexHeatmap()
click_action = NULL, brush_action = NULL,
# other configurations
js_code = "", close_button = TRUE, cancel_action = c("remove", "hide")
) {
if(is.null(heatmap_id)) {
increase_widget_index()
heatmap_id = paste0("ht", get_widget_index())
}
heatmap_id = validate_heatmap_id(heatmap_id)
insertUI(selector = qq("body"),
where = "beforeEnd",
ui = htmlOutput(qq("@{heatmap_id}_heatmap_modal_ui")))
if(is.function(js_code)) js_code = js_code(heatmap_id)
js_code = paste(js_code, collapse = "\n")
cancel_action = match.arg(cancel_action)[1]
output[[qq("@{heatmap_id}_heatmap_modal_ui")]] = renderUI({
div(id = qq("@{heatmap_id}_heatmap_modal_background"),
div(id = qq("@{heatmap_id}_heatmap_modal"),
class = "heatmap_modal",
span(id = qq("@{heatmap_id}_heatmap_modal_close_icon"),
HTML("<i class='fa fa-times'></i>")
),
InteractiveComplexHeatmapOutput(heatmap_id = heatmap_id, title1 = title1, title2 = title2,
width1 = width1, height1 = height1, width2 = width2, height2 = height2, width3 = width3, layout = layout, compact = compact,
action = action, cursor = cursor, response = response, brush_opt = brush_opt, output_ui = output_ui, output_ui_float = output_ui_float,
internal = TRUE),
if(close_button) {
tagList(
tags$hr(),
tags$button("Close widget", id = qq("@{heatmap_id}_heatmap_modal_close"), class="btn btn-default")
)
} else {
NULL
},
tags$script(qq("
Shiny.setInputValue('@{heatmap_id}_heatmap_modal_open', Math.random());
"))
),
tags$style(HTML(qq("
#@{heatmap_id}_heatmap_modal_background {
left: 0;
right: 0;
top: 0;
bottom: 0;
position: fixed;
background-color: rgb(0, 0, 0, 0.5);
overflow-y: auto;
}
#@{heatmap_id}_heatmap_modal {
position: relative;
margin: 50px;
padding: 20px;
background-color: #fff;
background-clip: padding-box;
transition: opacity .15s linear;
box-shadow: 0 5px 15px rgba(0,0,0,.25);
border: 1px solid rgba(0,0,0,.2);
border-radius: 6px;
outline: 0;
}
#@{heatmap_id}_heatmap_modal_close_icon {
position: relative;
left: -10px;
top: -15px;
font-size: 1.5em;
background-color: white;
color: black;
}
#@{heatmap_id}_heatmap_modal_close_icon:hover {
cursor: pointer;
}
"))),
if(close_button) {
tags$script(HTML(qq("
$('#@{heatmap_id}_heatmap_modal_close').click(function() {
if('@{cancel_action}' == 'remove') {
Shiny.setInputValue('@{heatmap_id}_heatmap_modal_remove', Math.random());
$('#@{heatmap_id}_heatmap_modal_ui').remove();
} else {
$('#@{heatmap_id}_heatmap_modal_background').@{cancel_action}();
}
});
@{js_code}
")))
} else {
tags$script(HTML(qq("
$(document).mouseup(function(e) {
var container = $('#@{heatmap_id}_heatmap_modal');
if(!container.is(e.target) && container.has(e.target).length === 0 && $('.heatmap_modal').length == 1) {
$('#@{heatmap_id}_heatmap_modal_background').@{cancel_action}();
if('@{cancel_action}' == 'remove') {
Shiny.setInputValue('@{heatmap_id}_heatmap_modal_remove', Math.random());
$('#@{heatmap_id}_heatmap_modal_ui').remove();
}
}
});
@{js_code}
")))
},
tags$script(HTML(qq("
$('#@{heatmap_id}_heatmap_modal_close_icon').click(function() {
if('@{cancel_action}' == 'remove') {
Shiny.setInputValue('@{heatmap_id}_heatmap_modal_remove', Math.random());
$('#@{heatmap_id}_heatmap_modal_ui').remove();
} else {
$('#@{heatmap_id}_heatmap_modal_background').@{cancel_action}();
}
})
// code for pickr
// when parent element has 'position:fixed', the color picker is not correctly positioned
// following code manually adjust the positions of the color picker
$($('#@{heatmap_id}_heatmap_control ul li')[1]).click(function() {
var @{heatmap_id}_color_picker_buttons = $('#@{heatmap_id}_tabs-brush button.pcr-button');
$(@{heatmap_id}_color_picker_buttons[0]).click(function() {
var offset = $(@{heatmap_id}_color_picker_buttons[0]).offset();
var w = $(@{heatmap_id}_color_picker_buttons[0]).outerWidth();
var h = $(@{heatmap_id}_color_picker_buttons[0]).outerHeight();
$('#@{heatmap_id}_tabs-brush .pcr-app.visible').css('top', offset.top + h + 5).
css('left', offset.left);
})
$(@{heatmap_id}_color_picker_buttons[1]).click(function() {
var offset = $(@{heatmap_id}_color_picker_buttons[1]).offset();
var w = $(@{heatmap_id}_color_picker_buttons[1]).outerWidth();
var h = $(@{heatmap_id}_color_picker_buttons[1]).outerHeight();
$('#@{heatmap_id}_tabs-brush .pcr-app.visible').css('top', offset.top + h + 5).
css('left', offset.left);
})
})
")))
)
})
observeEvent(input[[qq("@{heatmap_id}_heatmap_modal_open")]], {
makeInteractiveComplexHeatmap(input, output, session, ht_list, heatmap_id = heatmap_id,
click_action = click_action, brush_action = brush_action)
}, once = TRUE)
observeEvent(input[[qq("@{heatmap_id}_heatmap_modal_remove")]], {
removeUI(qq("#@{heatmap_id}_heatmap_modal_background"))
})
}
# == title
# Interactive complex heatmap widget
#
# == param
# -input Passed from the Shiny server function.
# -output Passed from the Shiny server function.
# -session Passed from the Shiny server function.
# -ht_list A `ComplexHeatmap::Heatmap-class` or a `ComplexHeatmap::HeatmapList-class` object.
# -heatmap_id ID of the plot. If it is not specified, an internal ID is assigned.
# -output_id Where the heatmap is put.
# -title1 Pass to `InteractiveComplexHeatmapOutput`.
# -title2 Pass to `InteractiveComplexHeatmapOutput`.
# -width1 Pass to `InteractiveComplexHeatmapOutput`.
# -height1 Pass to `InteractiveComplexHeatmapOutput`.
# -width2 Pass to `InteractiveComplexHeatmapOutput`.
# -height2 Pass to `InteractiveComplexHeatmapOutput`.
# -width3 Pass to `InteractiveComplexHeatmapOutput`.
# -layout Pass to `InteractiveComplexHeatmapOutput`.
# -compact Pass to `InteractiveComplexHeatmapOutput`.
# -action Pass to `InteractiveComplexHeatmapOutput`.
# -cursor Pass to `InteractiveComplexHeatmapOutput`.
# -response Pass to `InteractiveComplexHeatmapOutput`.
# -brush_opt Pass to `InteractiveComplexHeatmapOutput`.
# -output_ui Pass to `InteractiveComplexHeatmapOutput`.
# -output_ui_float Pass to `InteractiveComplexHeatmapOutput`.
# -click_action Pass to `makeInteractiveComplexHeatmap`.
# -brush_action Pass to `makeInteractiveComplexHeatmap`.
# -js_code Additional JavaScript code that is put after the interactive heatmap UI. The value can be a text or a function
# that takes "heatmap ID" as the argument and returns the formatted JavaScript code.
# -close_button Whether to add a close button at the end of the widget.
# -cancel_action Whether to remove the UI from HTML or just hide it when the UI is closed.
#
# == details
# It creates an interactive heatmap widget according to a certain action. The UI is placed to the output ID that user defined.
#
# The function is normally put inside `shiny::observe` or `shiny::observeEvent`.
#
# == value
# No value is returned.
#
# == example
# if(interactive()) {
# require(ComplexHeatmap)
#
# ui = fluidPage(
# actionButton("show_heatmap", "Generate_heatmap"),
# htmlOutput("heatmap_output")
# )
#
# server = function(input, output, session) {
# m = matrix(rnorm(100), 10)
# ht = Heatmap(m)
#
# observeEvent(input$show_heatmap, {
# InteractiveComplexHeatmapWidget(input, output, session, ht,
# output_id = "heatmap_output")
# })
# }
# shiny::shinyApp(ui, server)
# }
InteractiveComplexHeatmapWidget = function(
input, output, session, ht_list, heatmap_id = NULL, output_id,
# parameters passed to InteractiveComplexHeatmapOutput()
title1 = "Original heatmap", title2 = "Selected sub-heatmap",
width1 = ifelse(layout == "1|(2-3)", 800, 450),
height1 = ifelse(layout == "1-(2|3)", 700, 350),
width2 = 370,
height2 = 350,
width3 = ifelse(layout == "(1-2)|3", 800, 370),
layout = ifelse("brush" %in% response, "(1-2)|3", "1-3"), compact = FALSE,
action = "click", cursor = TRUE, response = c(action, "brush"),
brush_opt = list(stroke = "#f00", opacity = 0.6),
output_ui = TRUE, output_ui_float = FALSE,
# parameters passed to makeInteractiveComplexHeatmap()
click_action = NULL, brush_action = NULL,
# other configurations
js_code = "", close_button = TRUE, cancel_action = c("remove", "hide")
) {
if(is.null(heatmap_id)) {
increase_widget_index()
heatmap_id = paste0("ht", get_widget_index())
}
heatmap_id = validate_heatmap_id(heatmap_id)
if(is.function(js_code)) js_code = js_code(heatmap_id)
js_code = paste(js_code, collapse = "\n")
cancel_action = match.arg(cancel_action)[1]
output[[output_id]] = renderUI({
div(id = qq("@{heatmap_id}_heatmap_widget"),
InteractiveComplexHeatmapOutput(heatmap_id = heatmap_id, title1 = title1, title2 = title2,
width1 = width1, height1 = height1, width2 = width2, height2 = height2, width3 = width3, layout = layout, compact = compact,
action = action, cursor = cursor, response = response, brush_opt = brush_opt, output_ui = output_ui, output_ui_float = output_ui_float,
internal = TRUE),
if(close_button) {
tagList(
tags$hr(),
tags$button("Close widget", id = qq("@{heatmap_id}_heatmap_widget_close"),
class = "btn btn-default"),
tags$script(HTML(qq("
$('#@{heatmap_id}_heatmap_widget_close').click(function() {
$('#@{heatmap_id}_heatmap_widget').@{cancel_action}();
if('@{cancel_action}' == 'remove') {
Shiny.setInputValue('@{heatmap_id}_heatmap_widget_remove', Math.random());
}
})
")))
)
} else {
NULL
},
tags$script(qq("
Shiny.setInputValue('@{heatmap_id}_heatmap_widget_open', Math.random());
@{js_code}
"))
)
})
observeEvent(input[[qq("@{heatmap_id}_heatmap_widget_open")]], {
makeInteractiveComplexHeatmap(input, output, session, ht_list, heatmap_id = heatmap_id,
click_action = click_action, brush_action = brush_action)
})
observeEvent(input[[qq("@{heatmap_id}_heatmap_widget_remove")]], {
removeUI(qq("#@{heatmap_id}_widget"))
})
}
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.