teal.widgets coverage - 58.90%

Files
Source

File	Lines	Relevant	Covered	Missed	Hits / Line	Coverage
R/draggable_buckets.R	164	72	0	72	0	0.00%
R/panel_group.R	137	30	0	30	0	0.00%
R/nested_closeable_modal.R	99	15	0	15	0	0.00%
R/get_dt_rows.R	57	8	0	8	0	0.00%
R/white_small_well.R	26	4	0	4	0	0.00%
R/optionalInput.R	599	208	39	169	3	18.75%
R/verbatim_popup.R	195	78	38	40	2	48.72%
R/standard_layout.R	116	37	24	13	1	64.86%
R/plot_with_settings.R	640	250	231	19	7	92.40%
R/table_with_settings.R	239	119	118	1	4	99.16%
R/ggplot2_args.R	181	41	41	0	33	100.00%
R/basic_table_args.R	113	22	22	0	40	100.00%
R/utils.R	34	10	10	0	12	100.00%

#' Creates `ggplot2_args` object
#'
#' @description `r lifecycle::badge("experimental")`
#' Constructor of `ggplot2_args` class of objects.
#' The `ggplot2_args` argument should be a part of every module which contains any `ggplot2` graphics.
#' The function arguments are validated to match their `ggplot2` equivalents.
#'
#' For more details see the vignette: `vignette("custom-ggplot2-arguments", package = "teal.widgets")`.
#'
#' @seealso
#' * [resolve_ggplot2_args()] to resolve multiple objects into one using pre-defined priorities.
#' * [parse_ggplot2_args()] to parse resolved list into list of calls.
#'
#' @param labs (named `list`)\cr
#'  where all fields have to match [ggplot2::labs()] arguments.
#' @param theme (named `list`)\cr
#'  where all fields have to match [ggplot2::theme()] arguments.
#'
#' @return (`ggplot2_args`) object.
#' @export
#' @examples
#' ggplot2_args(
#'   labs = list(title = "TITLE"),
#'   theme = list(title = ggplot2::element_text(size = 20))
#' )
ggplot2_args <- function(labs = list(), theme = list()) {
  checkmate::assert_list(labs)
  checkmate::assert_list(theme)
  checkmate::assert_character(names(labs), unique = TRUE, null.ok = TRUE)
  checkmate::assert_character(names(theme), unique = TRUE, null.ok = TRUE)

  ggplot2_theme <- methods::formalArgs(ggplot2::theme)
  # utils::getFromNamespace is not recommended nevertheless needed as it is replacing `:::`.
  # usage of static values will be vulnerable to any changes in ggplot2 aesthetics.
  ggplot2_labs <- c(
    utils::getFromNamespace(".all_aesthetics", "ggplot2"),
    methods::formalArgs(ggplot2::labs)
  )
  checkmate::assert_subset(names(labs), choices = ggplot2_labs, empty.ok = TRUE)
  checkmate::assert_subset(names(theme), choices = ggplot2_theme, empty.ok = TRUE)

  structure(list(labs = labs, theme = theme), class = "ggplot2_args")
}

#' Resolving and reducing multiple `ggplot2_args` objects
#'
#' @description `r lifecycle::badge("experimental")`
#' Resolving and reducing multiple `ggplot2_args` objects.
#' This function is intended to utilize user provided settings, defaults provided by the module creator and
#' also `teal` option. See `Details`, below, to understand the logic.
#'
#' @seealso [parse_ggplot2_args()] to parse resolved list into list of calls.
#'
#' @param user_plot (`ggplot2_args`)\cr
#'  end user setup for theme and labs in the specific plot.
#'  Created with the [ggplot2_args()] function. The `NULL` value is supported.
#' @param user_default (`ggplot2_args`)\cr
#'  end user setup for module default theme and labs.
#'  Created with the [ggplot2_args()] function. The `NULL` value is supported.
#' @param module_plot (`ggplot2_args`)\cr
#'  module creator setup for theme and labs in the specific plot.
#'  Created with the [ggplot2_args()] function. The `NULL` value is supported.
#' @param app_default (`ggplot2_args`)\cr
#'  Application level setting. Can be `NULL`.
#'
#' @return `ggplot2_args` object.
#'
#' @details
#' The function picks the first non `NULL` value for each argument, checking in the following order:
#' 1. `ggplot2_args` argument provided by the end user.
#' Per plot (`user_plot`) and then default (`user_default`) setup.
#' 2. `app_default` global R variable, `teal.ggplot2_args`.
#' 3. `module_plot` which is a module creator setup.
#' @export
#' @examples
#' resolve_ggplot2_args(
#'   user_plot = ggplot2_args(
#'     labs = list(title = "TITLE"),
#'     theme = list(title = ggplot2::element_text(size = 20))
#'   ),
#'   user_default = ggplot2_args(
#'     labs = list(x = "XLAB")
#'   )
#' )
resolve_ggplot2_args <- function(user_plot = ggplot2_args(),
                                 user_default = ggplot2_args(),
                                 module_plot = ggplot2_args(),
                                 app_default = getOption("teal.ggplot2_args", ggplot2_args())) {
  checkmate::assert_class(user_plot, "ggplot2_args", null.ok = TRUE)
  checkmate::assert_class(user_default, "ggplot2_args", null.ok = TRUE)
  checkmate::assert_class(module_plot, "ggplot2_args", null.ok = TRUE)
  checkmate::assert_class(app_default, "ggplot2_args", null.ok = TRUE)

  ggplot2_args_all <- list(
    "plot" = user_plot,
    "default" = user_default,
    "teal" = app_default,
    "module" = module_plot
  )

  labs_args <- Reduce(`c`, lapply(ggplot2_args_all, function(x) x$labs))
  labs_args <- if (is.null(labs_args)) list() else labs_args[!duplicated(names(labs_args))]

  theme_args <- Reduce(`c`, lapply(ggplot2_args_all, function(x) x$theme))
  theme_args <- if (is.null(theme_args)) list() else theme_args[!duplicated(names(theme_args))]

  ggplot2_args(labs = labs_args, theme = theme_args)
}

#' Parse `ggplot2_args` object into the `ggplot2` expression
#'
#' @description `r lifecycle::badge("experimental")`
#' A function to parse expression from the `ggplot2_args` object.
#' @param ggplot2_args (`ggplot2_args`)\cr
#'  This argument could be a result of the [resolve_ggplot2_args()].
#' @param ggtheme (`character(1)`)\cr
#'  name of the `ggplot2` theme to be applied, e.g. `"dark"`.
#'
#' @return (`list`) of up to three elements of class `languange`: `"labs"`, `"ggtheme"` and `"theme"`.
#' @export
#' @examples
#' parse_ggplot2_args(
#'   resolve_ggplot2_args(ggplot2_args(
#'     labs = list(title = "TITLE"),
#'     theme = list(title = ggplot2::element_text(size = 20))
#'   ))
#' )
#'
#' parse_ggplot2_args(
#'   resolve_ggplot2_args(
#'     ggplot2_args(
#'       labs = list(title = "TITLE"),
#'       theme = list(title = ggplot2::element_text(size = 20))
#'     )
#'   ),
#'   ggtheme = "gray"
#' )
parse_ggplot2_args <- function(ggplot2_args = teal.widgets::ggplot2_args(),
                               ggtheme = c(
                                 "default",
                                 "gray",
                                 "bw",
                                 "linedraw",
                                 "light",
                                 "dark",
                                 "minimal",
                                 "classic",
                                 "void",
                                 "test"
                               )) {
  checkmate::assert_class(ggplot2_args, "ggplot2_args")
  ggtheme <- match.arg(ggtheme)

  res_list <- list()

  labs_args <- ggplot2_args$labs

  labs_f <- if (length(labs_args)) {
    as.call(c(list(quote(ggplot2::labs)), labs_args))
  } else {
    NULL
  }

  default_theme <- if (ggtheme != "default") {
    as.call(list(str2lang(paste0("ggplot2::theme_", ggtheme))))
  } else {
    NULL
  }

  theme_args <- ggplot2_args$theme

  theme_f <- if (length(theme_args)) {
    as.call(c(list(quote(ggplot2::theme)), theme_args))
  } else {
    NULL
  }

  final_list <- Filter(Negate(is.null), list(labs = labs_f, ggtheme = default_theme, theme = theme_f))
  # For empty final_list we want to return empty list, not empty named list
  `if`(length(final_list) == 0, list(), final_list)
}

#' Wrapper for `pickerInput`
#'
#' @description `r lifecycle::badge("stable")`
#' Wrapper for [shinyWidgets::pickerInput()] with additional features.
#' When `fixed = TRUE` or when the number of `choices` is less or equal to 1 (see `fixed_on_single`),
#' the `pickerInput` widget is hidden and non-interactive widget will be displayed
#' instead. Toggle of `HTML` elements is just the visual effect to avoid displaying
#' `pickerInput` widget when there is only one choice.
#'
#' @inheritParams shinyWidgets::pickerInput
#'
#' @param sep (`character(1)`)\cr
#'  A separator string to split the `choices` or `selected` inputs into the values of the different
#'  columns.
#'
#' @param label_help (`shiny.tag`) optional,\cr
#'  e.g. an object returned by [shiny::helpText()].
#'
#' @param fixed (`logical(1)`) optional,\cr
#'  whether to block user to select choices.
#'
#' @param fixed_on_single (`logical(1)`) optional,\cr
#'  whether to block user to select a choice when there is only one or less choice.
#'  When `FALSE`, user is still able to select or deselect the choice.
#'
#' @param width (`character(1)`)\cr
#'  The width of the input passed to `pickerInput`  e.g. `'auto'`, `'fit'`, `'100px'` or `'75%'`
#'
#' @return (`shiny.tag`) HTML tag with `pickerInput` widget and
#'  non-interactive element listing selected values.
#'
#' @export
#'
#' @examples
#' library(shiny)
#'
#' # Create a minimal example data frame
#' data <- data.frame(
#'   AGE = c(25, 30, 40, 35, 28),
#'   SEX = c("Male", "Female", "Male", "Female", "Male"),
#'   PARAMCD = c("Val1", "Val2", "Val3", "Val4", "Val5"),
#'   PARAM = c("Param1", "Param2", "Param3", "Param4", "Param5"),
#'   AVISIT = c("Visit1", "Visit2", "Visit3", "Visit4", "Visit5"),
#'   stringsAsFactors = TRUE
#' )
#'
#' ui_grid <- function(...) {
#'   bslib::page_fluid(
#'     bslib::layout_columns(
#'       col_widths = c(4, 4, 4),
#'       ...
#'     )
#'   )
#' }
#'
#' ui <- ui_grid(
#'   wellPanel(
#'     optionalSelectInput(
#'       inputId = "c1",
#'       label = "Fixed choices",
#'       choices = LETTERS[1:5],
#'       selected = c("A", "B"),
#'       fixed = TRUE
#'     ),
#'     verbatimTextOutput(outputId = "c1_out")
#'   ),
#'   wellPanel(
#'     optionalSelectInput(
#'       inputId = "c2",
#'       label = "Single choice",
#'       choices = "A",
#'       selected = "A"
#'     ),
#'     verbatimTextOutput(outputId = "c2_out")
#'   ),
#'   wellPanel(
#'     optionalSelectInput(
#'       inputId = "c3",
#'       label = "NULL choices",
#'       choices = NULL
#'     ),
#'     verbatimTextOutput(outputId = "c3_out")
#'   ),
#'   wellPanel(
#'     optionalSelectInput(
#'       inputId = "c4",
#'       label = "Default",
#'       choices = LETTERS[1:5],
#'       selected = "A"
#'     ),
#'     verbatimTextOutput(outputId = "c4_out")
#'   ),
#'   wellPanel(
#'     optionalSelectInput(
#'       inputId = "c5",
#'       label = "Named vector",
#'       choices = c(`A - value A` = "A", `B - value B` = "B", `C - value C` = "C"),
#'       selected = "A"
#'     ),
#'     verbatimTextOutput(outputId = "c5_out")
#'   ),
#'   wellPanel(
#'     selectInput(
#'       inputId = "c6_choices", label = "Update choices", choices = letters, multiple = TRUE
#'     ),
#'     optionalSelectInput(
#'       inputId = "c6",
#'       label = "Updated choices",
#'       choices = NULL,
#'       multiple = TRUE,
#'       fixed_on_single = TRUE
#'     ),
#'     verbatimTextOutput(outputId = "c6_out")
#'   )
#' )
#'
#' server <- function(input, output, session) {
#'   observeEvent(input$c6_choices, ignoreNULL = FALSE, {
#'     updateOptionalSelectInput(
#'       session = session,
#'       inputId = "c6",
#'       choices = input$c6_choices,
#'       selected = input$c6_choices
#'     )
#'   })
#'
#'   output$c1_out <- renderPrint(input$c1)
#'   output$c2_out <- renderPrint(input$c2)
#'   output$c3_out <- renderPrint(input$c3)
#'   output$c4_out <- renderPrint(input$c4)
#'   output$c5_out <- renderPrint(input$c5)
#'   output$c6_out <- renderPrint(input$c6)
#' }
#'
#' if (interactive()) {
#'   shinyApp(ui, server)
#' }
#'
optionalSelectInput <- function(inputId, # nolint
                                label = NULL,
                                choices = NULL,
                                selected = NULL,
                                multiple = FALSE,
                                sep = NULL,
                                options = list(),
                                label_help = NULL,
                                fixed = FALSE,
                                fixed_on_single = FALSE,
                                width = NULL) {
  checkmate::assert_string(inputId)
  checkmate::assert(
    checkmate::check_string(label, null.ok = TRUE),
    checkmate::check_class(label, "shiny.tag"),
    checkmate::check_class(label, "shiny.tag.list"),
    checkmate::check_class(label, "html")
  )
  stopifnot(is.null(choices) || length(choices) >= 1)
  stopifnot(
    is.null(selected) ||
      length(selected) == 0 ||
      all(selected %in% choices) ||
      all(selected %in% unlist(choices, recursive = FALSE))
  )
  checkmate::assert_flag(multiple)
  checkmate::assert_string(sep, null.ok = TRUE)
  checkmate::assert_list(options)
  checkmate::assert(
    checkmate::check_string(label_help, null.ok = TRUE),
    checkmate::check_class(label_help, "shiny.tag"),
    checkmate::check_class(label_help, "shiny.tag.list"),
    checkmate::check_class(label_help, "html")
  )
  checkmate::assert_flag(fixed)
  checkmate::assert_flag(fixed_on_single)

  if (!is.null(width)) {
    validateCssUnit(width)
  }

  default_options <- list(
    "actions-box" = multiple,
    "none-selected-text" = "- Nothing selected -",
    "max-options" = ifelse(multiple, Inf, 1),
    "show-subtext" = TRUE,
    "live-search" = ifelse(length(choices) > 10, TRUE, FALSE)
  )

  options <- if (!identical(options, list())) {
    c(options, default_options[setdiff(names(default_options), names(options))])
  } else {
    default_options
  }

  if (is.null(choices)) {
    choices <- ""
    selected <- NULL
  }

  if (length(choices) <= 1 && fixed_on_single) fixed <- TRUE

  raw_choices <- extract_raw_choices(choices, attr(choices, "sep"))
  raw_selected <- extract_raw_choices(selected, attr(choices, "sep"))

  # Making sure the default dropdown popup can be displayed in the whole body, even outside the sidebars.
  if (is.null(options$container)) {
    options$container <- "body"
  }

  ui_picker <- tags$div(
    id = paste0(inputId, "_input"),
    # visibility feature marked with display: none/block instead of shinyjs::hide/show
    #  as mechanism to hide/show is handled by javascript code
    style = if (fixed) "display: none;" else "display: block;",
    shinyWidgets::pickerInput(
      inputId = inputId,
      label = label,
      choices = raw_choices,
      selected = raw_selected,
      multiple = TRUE,
      width = width,
      options = options,
      choicesOpt = picker_options(choices)
    )
  )

  if (!is.null(label_help)) {
    ui_picker[[3]] <- append(ui_picker[[3]], list(tags$div(class = "label-help", label_help)), after = 1)
  }

  ui_fixed <- tags$div(
    id = paste0(inputId, "_fixed"),
    # visibility feature marked with display: none/block instead of shinyjs::hide/show
    #  as mechanism to hide/show is handled by javascript code
    style = if (fixed) "display: block;" else "display: none;",
    tags$label(class = "control-label", label),
    # selected values as verbatim text
    tags$code(
      id = paste0(inputId, "_selected_text"),
      if (length(selected) > 0) {
        toString(selected)
      } else {
        "NULL"
      }
    ),
    label_help
  )

  tags$div(
    # when selected values in ui_picker change
    # then update ui_fixed - specifically, update '{id}_selected_text' element
    tags$script(
      sprintf(
        "
        $(function() {
          $('#%1$s').on('change', function(e) {
            var select_concat = $(this).val().length ? $(this).val().join(', ') : 'NULL';
            $('#%1$s_selected_text').html(select_concat);
          })
        })",
        inputId
      )
    ),

    # if ui_picker has only one or less option or is fixed then hide {id}_input and show {id}_fixed
    if (fixed_on_single) {
      js <- sprintf(
        "$(function() {
          $('#%1$s').on('change', function(e) {
            var options = $('#%1$s').find('option');
            if (options.length == 1) {
              $('#%1$s_input').hide();
              $('#%1$s_fixed').show();
            } else {
              $('#%1$s_input').show();
              $('#%1$s_fixed').hide();
            }
          })
        })",
        inputId
      )
      tags$script(js)
    },
    tags$div(ui_picker, ui_fixed)
  )
}

#' @rdname optionalSelectInput
#' @param session (`shiny.session`)\cr
#' @export
updateOptionalSelectInput <- function(session, # nolint
                                      inputId, # nolint
                                      label = NULL,
                                      selected = NULL,
                                      choices = NULL) {
  raw_choices <- extract_raw_choices(choices, attr(choices, "sep"))
  raw_selected <- extract_raw_choices(selected, attr(choices, "sep"))

  # update picker input
  shinyWidgets::updatePickerInput(
    session = session,
    inputId = inputId,
    label = label,
    selected = as.character(raw_selected),
    choices = raw_choices,
    choicesOpt = picker_options(choices)
  )

  invisible(NULL)
}

#' Get icons to represent variable types in dataset
#'
#' @param var_type (`character`)\cr
#'  of R internal types (classes).
#'
#' @return (`character`)\cr
#'  vector of HTML icons corresponding to  data type in each column.
#' @keywords internal
#'
variable_type_icons <- function(var_type) {
  checkmate::assert_character(var_type, any.missing = FALSE)

  class_to_icon <- list(
    numeric = "arrow-up-1-9",
    integer = "arrow-up-1-9",
    logical = "pause",
    Date = "calendar",
    POSIXct = "calendar",
    POSIXlt = "calendar",
    factor = "chart-bar",
    character = "keyboard",
    primary_key = "key",
    unknown = "circle-question"
  )
  class_to_icon <- lapply(class_to_icon, function(icon_name) toString(icon(icon_name, lib = "font-awesome")))

  res <- unname(vapply(
    var_type,
    FUN.VALUE = character(1),
    FUN = function(class) {
      if (class == "") {
        class
      } else if (is.null(class_to_icon[[class]])) {
        class_to_icon[["unknown"]]
      } else {
        class_to_icon[[class]]
      }
    }
  ))

  res
}

#' Optional content for `optionalSelectInput`
#'
#' Prepares content to be displayed in `optionalSelectInput` with icons and labels
#'
#' @param var_name (`character`)\cr
#'  variable name
#' @param var_label (`character`)\cr
#'  variable alternative name - for example variable label
#' @param var_type (`character`)
#' class of the variable.
#'
#' @return (`character`) HTML contents with all elements combined
#' @keywords internal
#'
picker_options_content <- function(var_name, var_label, var_type) {
  if (length(var_name) == 0) {
    res <- character(0)
  } else if (length(var_type) == 0 && length(var_label) == 0) {
    res <- var_name
  } else {
    checkmate::assert_character(var_name, min.len = 1, any.missing = FALSE)
    stopifnot(
      identical(var_type, character(0)) || length(var_type) == length(var_name),
      identical(var_label, character(0)) || length(var_label) == length(var_name)
    )

    var_icon <- variable_type_icons(var_type)

    res <- trimws(paste(
      var_icon,
      var_name,
      vapply(
        var_label,
        function(x) {
          ifelse(x == "", "", toString(tags$small(x, class = "text-muted")))
        },
        character(1)
      )
    ))
  }

  res
}

#' Create `choicesOpt` for `pickerInput`
#'
#' @param choices (`choices_labeled` or `character`)\cr
#'  choices vector
#'
#' @return (`list`)\cr
#'  to be passed as `choicesOpt` argument.
#' @keywords internal
picker_options <- function(choices) {
  if (inherits(choices, "choices_labeled")) {
    raw_choices <- extract_raw_choices(choices, sep = attr(choices, "sep"))
    res <- list(
      content = picker_options_content(
        var_name  = raw_choices,
        var_label = extract_choices_labels(choices),
        var_type  = if (is.null(attr(choices, "types"))) character(0) else attr(choices, "types")
      )
    )
  } else if (all(vapply(choices, inherits, logical(1), "choices_labeled"))) {
    choices <- unlist(unname(choices))
    res <- list(content = picker_options_content(
      var_name  = choices,
      var_label = extract_choices_labels(choices),
      var_type  = if (is.null(attr(choices, "types"))) character(0) else attr(choices, "types")
    ))
  } else {
    res <- NULL
  }
  res
}

#' Extract raw values from choices
#'
#' @param choices (`choices_labeled`, `list` or `character`)\cr
#'  object containing choices
#' @param sep (`character(1)`)\cr
#'  A separator string to split the `choices` or `selected` inputs into the values of
#'  the different columns.
#' @return choices simplified
#' @keywords internal
extract_raw_choices <- function(choices, sep) {
  if (!is.null(sep)) {
    vapply(choices, paste, collapse = sep, character(1))
  } else if (inherits(choices, "choices_labeled")) {
    unname(unlist(choices))
  } else {
    choices
  }
}

#' if min or max are `NA` then the slider widget will be hidden
#'
#' @description `r lifecycle::badge("stable")`\cr
#' Hidden input widgets are useful to have the `input[[inputId]]` variable
#' on available in the server function but no corresponding visual clutter from
#' input widgets that provide only a single choice.
#'
#' @inheritParams shiny::sliderInput
#' @param label_help (`shiny.tag`) optional\cr
#'  object of class `shiny.tag`, e.g. an object returned by [shiny::helpText()]
#' @param ... optional arguments to `sliderInput`
#'
#' @return (`shiny.tag`) HTML tag with `sliderInput` widget.
#'
#' @export
#'
#' @examples
#' ui <- bslib::page_fluid(
#'   shinyjs::useShinyjs(),
#'   optionalSliderInput("s", "shown", 0, 1, 0.2),
#'   optionalSliderInput("h", "hidden", 0, NA, 1),
#' )
#' if (interactive()) {
#'   shiny::shinyApp(ui, function(input, output) {})
#' }
optionalSliderInput <- function(inputId, label, min, max, value, label_help = NULL, ...) { # nolint
  checkmate::assert_number(min, na.ok = TRUE)
  checkmate::assert_number(max, na.ok = TRUE)
  checkmate::assert_numeric(value, min.len = 1, max.len = 2, any.missing = FALSE)

  is_na_min <- is.na(min)
  is_na_max <- is.na(max)

  hide <- is_na_min || is_na_max

  if (length(value) == 2) {
    value1 <- value[1]
    value2 <- value[2]
  } else {
    value1 <- value
    value2 <- value
  }

  if (is_na_min) {
    min <- value1 - 1
  }
  if (is_na_max) {
    max <- value2 + 1
  }

  if (min > value1 || max < value2) {
    stop("arguments inconsistent: min <= value <= max expected")
  }

  slider <- sliderInput(inputId, label, min, max, value, ...)

  if (!is.null(label_help)) {
    slider[[3]] <- append(slider[[3]], list(tags$div(class = "label-help", label_help)), after = 1)
  }

  if (hide) {
    shinyjs::hidden(slider)
  } else {
    slider
  }
}

#' For `teal` modules we parameterize an `optionalSliderInput` with one argument
#' `value_min_max`
#'
#' @description `r lifecycle::badge("stable")`
#' The [optionalSliderInput()] function needs three arguments to determine
#' whether to hide the `sliderInput` widget or not. For `teal` modules we specify an
#' optional slider input with one argument here called `value_min_max`.
#'
#' @inheritParams optionalSliderInput
#'
#' @param value_min_max (`numeric(1)` or `numeric(3)`)\cr
#'  If of length 1 then the value gets set to that number and the `sliderInput` will be hidden.
#'  Otherwise, if it is of length three the three elements will map to `value`, `min` and `max` of
#'  the [optionalSliderInput()] function.
#'
#' @return (`shiny.tag`) HTML tag with range `sliderInput` widget.
#'
#' @export
#'
#' @examples
#'
#' ui <- bslib::page_fluid(
#'   shinyjs::useShinyjs(),
#'   optionalSliderInputValMinMax("a1", "b1", 1),
#'   optionalSliderInputValMinMax("a2", "b2", c(3, 1, 5))
#' )
#' if (interactive()) {
#'   shiny::shinyApp(ui, function(input, output) {})
#' }
optionalSliderInputValMinMax <- function(inputId, label, value_min_max, label_help = NULL, ...) { # nolint
  checkmate::assert(
    checkmate::check_numeric(
      value_min_max,
      finite = TRUE,
      len = 3
    ),
    checkmate::check_numeric(
      value_min_max,
      finite = TRUE,
      len = 1
    )
  )

  x <- value_min_max

  vals <- if (length(x) == 3) {
    checkmate::assert_number(x[1], lower = x[2], upper = x[3], .var.name = "value_min_max")
    list(value = x[1], min = x[2], max = x[3])
  } else if (length(x) == 1) {
    list(value = x, min = NA_real_, max = NA_real_)
  }

  slider <- optionalSliderInput(inputId, label, vals$min, vals$max, vals$value, ...)

  if (!is.null(label_help)) {
    slider[[3]] <- append(slider[[3]], list(tags$div(class = "label-help", label_help)), after = 1)
  }
  slider
}

#' Extract labels from choices basing on attributes and names
#'
#' @param choices (`list` or `vector`)\cr
#'  select choices
#' @param values optional\cr
#'  choices subset for which labels should be extracted, `NULL` for all choices.
#'
#' @return (`character`) vector with labels
#' @keywords internal
extract_choices_labels <- function(choices, values = NULL) {
  res <- if (inherits(choices, "choices_labeled")) {
    attr(choices, "raw_labels")
  } else if (!is.null(names(choices)) && !setequal(names(choices), unlist(unname(choices)))) {
    names(choices)
  } else {
    NULL
  }

  if (!is.null(values) && !is.null(res)) {
    stopifnot(all(values %in% choices))
    res <- res[vapply(values, function(val) which(val == choices), numeric(1))]
  }

  res
}

#' @keywords internal
#' @noRd
plot_with_settings_deps <- function() {
  htmltools::htmlDependency(
    name = "teal-widgets-plot-with-settings",
    version = utils::packageVersion("teal.widgets"),
    package = "teal.widgets",
    src = "plot-with-settings",
    stylesheet = "plot-with-settings.css",
    script = "plot-with-settings.js"
  )
}

#' @name plot_with_settings
#' @rdname plot_with_settings
#' @export
plot_with_settings_ui <- function(id) {
  checkmate::assert_string(id)

  ns <- NS(id)

  tags$div(
    plot_with_settings_deps(),
    shinyjs::useShinyjs(),
    bslib::card(
      id = ns("plot-with-settings"),
      full_screen = TRUE,
      tags$div(
        tags$div(
          class = "teal-widgets settings-buttons",
          bslib::tooltip(
            trigger = tags$div(
              bslib::popover(
                id = ns("expbut"),
                trigger = icon("maximize"),
                uiOutput(ns("slider_ui")),
                uiOutput(ns("width_warning"))
              )
            ),
            options = list(trigger = "hover"),
            class = "resize-button",
            "Resize"
          ),
          bslib::tooltip(
            trigger = tags$div(type_download_ui(ns("downbutton"))),
            options = list(trigger = "hover"),
            class = "download-button",
            "Download"
          )
        ),
        tags$div(
          id = ns("plot-out-main"),
          class = "teal-widgets plot-content",
          uiOutput(ns("plot_out_main"))
        )
      )
    )
  )
}

#' Plot-with-settings module
#'
#' @rdname plot_with_settings
#' @description `r lifecycle::badge("stable")`\cr
#' Universal module for plots with settings for height, width, and download.
#'
#' @export
#'
#' @param id (`character(1)`) `shiny` module id.
#'
#' @param plot_r (`reactive` or `function`)\cr
#'  `reactive` expression or a simple `function` to draw a plot.
#'  A simple `function` is needed e.g. for base plots like `plot(1)` as the output can not be caught when downloading.
#'  Take into account that simple functions are less efficient than reactive, as not catching the result.
#' @param height (`numeric`) optional\cr
#'  vector with three elements c(VAL, MIN, MAX), where VAL is the starting value of the slider in
#'  the main and expanded plot display.
#' @param width (`numeric`) optional\cr
#'  vector with three elements `c(VAL, MIN, MAX)`, where VAL is the starting value of the slider in
#'  the main and expanded plot display; `NULL` for default display.
#' @param show_hide_signal optional, (`reactive logical` a mechanism to allow modules which call this
#'     module to show/hide the plot_with_settings UI)
#' @param brushing (`logical`) optional\cr
#'  mechanism to enable / disable brushing on the main plot.
#' All the brushing data is stored as a reactive object in the `"brush"` element of
#'  returned list. See the example for details.
#' @param clicking (`logical`)\cr
#'  a mechanism to enable / disable clicking on data points on the main plot.
#' All the clicking data is stored as a reactive object in the `"click"`
#'  element of returned list. See the example for details.
#' @param dblclicking (`logical`) optional\cr
#'  mechanism to enable / disable double-clicking on data points on the main plot.
#' All the double clicking data is stored as a reactive object in the
#'  the `"dblclick"` element of returned list. See the example for details.
#' @param hovering (`logical(1)`) optional\cr
#'  mechanism to enable / disable hovering over data points on the main plot.
#' All the hovering data is stored as a reactive object in the
#' `"hover"` element of returned list. See the example for details.
#' @param graph_align (`character(1)`) optional,\cr
#'  one of `"left"` (default), `"center"`, `"right"` or `"justify"`. The alignment of the graph on
#'  the main page.
#'
#' @details By default the plot is rendered with `72 dpi`. In order to change this, to for example 96 set
#' `options(teal.plot_dpi = 96)`. The minimum allowed `dpi` value is `24` and it must be a whole number.
#' If an invalid value is set then the default value is used and a warning is outputted to the console.
#'
#' @return A `shiny` module.
#'
#' @examples
#' # Example using a reactive as input to plot_r
#' library(shiny)
#' library(ggplot2)
#'
#' ui <- bslib::page_fluid(
#'   plot_with_settings_ui(
#'     id = "plot_with_settings"
#'   )
#' )
#'
#' server <- function(input, output, session) {
#'   plot_r <- reactive({
#'     ggplot(faithful, aes(x = .data$waiting, y = .data$eruptions)) +
#'       geom_point()
#'   })
#'
#'   plot_with_settings_srv(
#'     id = "plot_with_settings",
#'     plot_r = plot_r,
#'     height = c(400, 100, 1200),
#'     width = c(500, 250, 750)
#'   )
#' }
#'
#' if (interactive()) {
#'   shinyApp(ui, server)
#' }
#'
#' # Example using a function as input to plot_r
#' library(lattice)
#'
#' ui <- bslib::page_fluid(
#'   radioButtons("download_option", "Select the Option", list("ggplot", "trellis", "grob", "base")),
#'   plot_with_settings_ui(
#'     id = "plot_with_settings"
#'   ),
#'   sliderInput("nums", "Value", 1, 10, 1)
#' )
#'
#' server <- function(input, output, session) {
#'   plot_r <- function() {
#'     numbers <- seq_len(input$nums)
#'     if (input$download_option == "ggplot") {
#'       ggplot(data.frame(n = numbers), aes(.data$n)) +
#'         geom_bar()
#'     } else if (input$download_option == "trellis") {
#'       densityplot(numbers)
#'     } else if (input$download_option == "grob") {
#'       tr_plot <- densityplot(numbers)
#'       ggplotGrob(
#'         ggplot(data.frame(n = numbers), aes(.data$n)) +
#'           geom_bar()
#'       )
#'     } else if (input$download_option == "base") {
#'       plot(numbers)
#'     }
#'   }
#'
#'   plot_with_settings_srv(
#'     id = "plot_with_settings",
#'     plot_r = plot_r,
#'     height = c(400, 100, 1200),
#'     width = c(500, 250, 750)
#'   )
#' }
#'
#' if (interactive()) {
#'   shinyApp(ui, server)
#' }
#'
#' # Example with brushing/hovering/clicking/double-clicking
#' ui <- bslib::page_fluid(
#'   plot_with_settings_ui(
#'     id = "plot_with_settings"
#'   ),
#'   fluidRow(
#'     column(4, tags$h3("Brush"), verbatimTextOutput("brushing_data")),
#'     column(4, tags$h3("Click"), verbatimTextOutput("clicking_data")),
#'     column(4, tags$h3("DblClick"), verbatimTextOutput("dblclicking_data")),
#'     column(4, tags$h3("Hover"), verbatimTextOutput("hovering_data"))
#'   )
#' )
#'
#' server <- function(input, output, session) {
#'   plot_r <- reactive({
#'     ggplot(faithful, aes(x = .data$waiting, y = .data$eruptions)) +
#'       geom_point()
#'   })
#'
#'   plot_data <- plot_with_settings_srv(
#'     id = "plot_with_settings",
#'     plot_r = plot_r,
#'     height = c(400, 100, 1200),
#'     brushing = TRUE,
#'     clicking = TRUE,
#'     dblclicking = TRUE,
#'     hovering = TRUE
#'   )
#'
#'   output$brushing_data <- renderPrint(plot_data$brush())
#'   output$clicking_data <- renderPrint(plot_data$click())
#'   output$dblclicking_data <- renderPrint(plot_data$dblclick())
#'   output$hovering_data <- renderPrint(plot_data$hover())
#' }
#'
#' if (interactive()) {
#'   shinyApp(ui, server)
#' }
#'
#' # Example which allows module to be hidden/shown
#' library("shinyjs")
#'
#' ui <- bslib::page_fluid(
#'   useShinyjs(),
#'   actionButton("button", "Show/Hide"),
#'   plot_with_settings_ui(
#'     id = "plot_with_settings"
#'   )
#' )
#'
#' server <- function(input, output, session) {
#'   plot_r <- plot_r <- reactive(
#'     ggplot(faithful, aes(x = .data$waiting, y = .data$eruptions)) +
#'       geom_point()
#'   )
#'
#'   show_hide_signal_rv <- reactiveVal(TRUE)
#'
#'   observeEvent(input$button, show_hide_signal_rv(!show_hide_signal_rv()))
#'
#'   plot_with_settings_srv(
#'     id = "plot_with_settings",
#'     plot_r = plot_r,
#'     height = c(400, 100, 1200),
#'     width = c(500, 250, 750),
#'     show_hide_signal = reactive(show_hide_signal_rv())
#'   )
#' }
#'
#' if (interactive()) {
#'   shinyApp(ui, server)
#' }
#'
plot_with_settings_srv <- function(id,
                                   plot_r,
                                   height = c(600, 200, 2000),
                                   width = NULL,
                                   show_hide_signal = reactive(TRUE),
                                   brushing = FALSE,
                                   clicking = FALSE,
                                   dblclicking = FALSE,
                                   hovering = FALSE,
                                   graph_align = "left") {
  checkmate::assert_string(id)
  checkmate::assert(
    checkmate::check_class(plot_r, "function"),
    checkmate::check_class(plot_r, "reactive")
  )
  checkmate::assert_numeric(height, min.len = 1, any.missing = FALSE)
  checkmate::assert_numeric(height, len = 3, any.missing = FALSE, finite = TRUE)
  checkmate::assert_numeric(height[1], lower = height[2], upper = height[3], .var.name = "height")
  checkmate::assert_numeric(width, len = 3, any.missing = FALSE, null.ok = TRUE, finite = TRUE)
  checkmate::assert_numeric(width[1], lower = width[2], upper = width[3], null.ok = TRUE, .var.name = "width")

  checkmate::assert_class(show_hide_signal, c("reactive", "function"))
  checkmate::assert_flag(brushing)
  checkmate::assert_flag(clicking)
  checkmate::assert_flag(dblclicking)
  checkmate::assert_flag(hovering)
  checkmate::assert_string(graph_align)
  checkmate::assert_subset(graph_align, c("left", "right", "center", "justify"))

  moduleServer(id, function(input, output, session) {
    ns <- session$ns
    shinyjs::runjs(
      sprintf(
        'establishPlotResizing("%s", "%s");',
        ns("plot-out-main"), # graph parent id
        ns("flex_width") # session input$ variable name
      )
    )
    default_w <- function() session$clientData[[paste0("output_", ns("plot_main_width"))]]
    default_h <- function() session$clientData[[paste0("output_", ns("plot_main_height"))]]

    default_slider_width <- reactiveVal(width)
    delayed_flex_width <- debounce(reactive(input$flex_width), millis = 100)

    if (is.null(width)) {
      # if width = NULL then set default_slider_width to be the value of the plot width on load
      observeEvent(session$clientData[[paste0("output_", ns("plot_main_width"))]],
        handlerExpr = {
          default_slider_width(default_w() * c(1, 0.5, 2.8))
        },
        once = TRUE,
        ignoreNULL = TRUE
      )

      observeEvent(delayed_flex_width(), {
        if (delayed_flex_width() > 0 && !isFALSE(input$width_resize_switch)) {
          default_slider_width(delayed_flex_width() * c(1, 0.5, 2.8))
          updateSliderInput(session, inputId = "width", value = delayed_flex_width())
        }
      })
    }

    plot_type <- reactive({
      if (inherits(plot_r(), "ggplot")) {
        "gg"
      } else if (inherits(plot_r(), "trellis")) {
        "trel"
      } else if (inherits(plot_r(), "grob")) {
        "grob"
      } else if (inherits(plot_r(), c("NULL", "histogram", "list")) && !inherits(plot_r, "reactive")) {
        "base"
      } else {
        "other"
      }
    })

    # allow modules which use this module to turn on and off the UI
    observeEvent(show_hide_signal(), {
      if (show_hide_signal()) {
        shinyjs::show("plot-with-settings")
      } else {
        shinyjs::hide("plot-with-settings")
      }
    })

    output$slider_ui <- renderUI({
      req(default_slider_width())
      tags$div(
        optionalSliderInputValMinMax(
          inputId = ns("height"),
          label = "Plot height",
          value_min_max = round(height),
          ticks = FALSE,
          step = 1L,
          round = TRUE
        ),
        tags$b("Plot width"),
        shinyWidgets::switchInput(
          inputId = ns("width_resize_switch"),
          onLabel = "ON",
          offLabel = "OFF",
          label = "Auto width",
          value = `if`(is.null(width), TRUE, FALSE),
          size = "mini",
          labelWidth = "80px"
        ),
        optionalSliderInputValMinMax(
          inputId = ns("width"),
          label = NULL,
          value_min_max = round(isolate(default_slider_width())),
          ticks = FALSE,
          step = 1L,
          round = TRUE
        )
      )
    })

    observeEvent(input$width_resize_switch | delayed_flex_width(), {
      if (length(input$width_resize_switch) && input$width_resize_switch) {
        shinyjs::disable("width")
        updateSliderInput(session, inputId = "width", value = delayed_flex_width())
      } else {
        shinyjs::enable("width")
      }
    })

    ranges <- reactiveValues(x = NULL, y = NULL)

    observeEvent(input$plot_dblclick, {
      brush <- input$plot_brush
      if (!is.null(brush)) {
        ranges$x <- c(brush$xmin, brush$xmax)
        ranges$y <- c(brush$ymin, brush$ymax)
      } else {
        ranges$x <- NULL
        ranges$y <- NULL
      }
    })

    p_height <- reactive(if (!is.null(input$height)) input$height else height[1])
    p_width <- reactive(
      if (!is.null(input$width)) {
        input$width
      } else {
        if (!is.null(default_slider_width()[1])) {
          default_slider_width()[1]
        } else {
          # Fallback to "auto"
          "auto"
        }
      }
    )
    output$plot_main <- renderPlot(
      apply_plot_modifications(
        plot_obj = plot_suppress(plot_r()),
        plot_type = plot_suppress(plot_type()),
        dblclicking = dblclicking,
        ranges = ranges
      ),
      res = get_plot_dpi(),
      height = p_height,
      width = p_width
    )

    output$plot_out_main <- renderUI({
      req(plot_suppress(plot_r()))
      tags$div(
        align = graph_align,
        plotOutput(
          ns("plot_main"),
          height = "100%",
          width = p_width(),
          brush = `if`(brushing, brushOpts(ns("plot_brush"), resetOnNew = FALSE), NULL),
          click = `if`(clicking, clickOpts(ns("plot_click")), NULL),
          dblclick = `if`(dblclicking, dblclickOpts(ns("plot_dblclick")), NULL),
          hover = `if`(hovering, hoverOpts(ns("plot_hover")), NULL)
        )
      )
    })

    output$width_warning <- renderUI({
      grDevices::pdf(nullfile()) # reset Rplots.pdf for shiny server
      w <- grDevices::dev.size("px")[1]
      grDevices::dev.off()
      if (p_width() < w) {
        helpText(
          icon("triangle-exclamation"),
          "Plot might be cut off for small widths."
        )
      }
    })

    type_download_srv(
      id = "downbutton",
      plot_reactive = plot_r,
      plot_type = plot_type,
      plot_w = p_width,
      default_w = default_w,
      plot_h = p_height,
      default_h = default_h
    )

    list(
      brush = reactive({
        # refresh brush data on the main plot size change
        input$height
        input$width
        input$plot_brush
      }),
      click = reactive({
        # refresh click data on the main plot size change
        input$height
        input$width
        input$plot_click
      }),
      dblclick = reactive({
        # refresh double click data on the main plot size change
        input$height
        input$width
        input$plot_dblclick
      }),
      hover = reactive({
        # refresh hover data on the main plot size change
        input$height
        input$width
        input$plot_hover
      }),
      dim = reactive(c(p_width(), p_height()))
    )
  })
}

#' @keywords internal
type_download_ui <- function(id) {
  ns <- NS(id)
  bslib::popover(
    icon("download"),
    tags$div(
      radioButtons(ns("file_format"),
        label = "File type",
        choices = c("png" = "png", "pdf" = "pdf", "svg" = "svg"),
      ),
      textInput(ns("file_name"),
        label = "File name (without extension)",
        value = paste0("plot_", strftime(Sys.time(), format = "%Y%m%d_%H%M%S"))
      ),
      conditionalPanel(
        condition = paste0("input['", ns("file_name"), "'] != ''"),
        downloadButton(ns("data_download"), label = character(0), class = "btn-sm w-full")
      )
    )
  )
}

#' @keywords internal
type_download_srv <- function(id, plot_reactive, plot_type, plot_w, default_w, plot_h, default_h) {
  moduleServer(
    id,
    function(input, output, session) {
      output$data_download <- downloadHandler(
        filename = function() {
          paste(input$file_name, input$file_format, sep = ".")
        },
        content = function(file) {
          width <- `if`(!is.null(plot_w()), plot_w(), default_w())
          height <- `if`(!is.null(plot_h()), plot_h(), default_h())

          # svg and pdf have width in inches and 1 inch = get_plot_dpi() pixels
          switch(input$file_format,
            png = grDevices::png(file, width, height),
            pdf = grDevices::pdf(file, width / get_plot_dpi(), height / get_plot_dpi()),
            svg = grDevices::svg(file, width / get_plot_dpi(), height / get_plot_dpi())
          )

          print_plot(plot_reactive, plot_type)

          grDevices::dev.off()
        }
      )
    }
  )
}

#' Clean brushed points
#'
#' @description `r lifecycle::badge("stable")`\cr
#' Cleans and organizes output to account for NAs and remove empty rows. Wrapper around `shiny::brushedPoints`.
#' @param data (`data.frame`)\cr
#'  A data.frame from which to select rows.
#' @param brush (`list`)\cr
#'  The data from a brush e.g. `input$plot_brush`.
#'
#' @return A `data.frame` of selected rows.
#'
#' @examples
#'
#' brush <- list(
#'   mapping = list(
#'     x = "AGE",
#'     y = "BMRKR1"
#'   ),
#'   xmin = 30, xmax = 40,
#'   ymin = 0.7, ymax = 10,
#'   direction = "xy"
#' )
#'
#' data <- data.frame(
#'   STUDYID = letters[1:20],
#'   USUBJID = LETTERS[1:20],
#'   AGE = sample(25:40, size = 20, replace = TRUE),
#'   BMRKR1 = runif(20, min = 0, max = 12)
#' )
#' nrow(clean_brushedPoints(data, brush))
#' data$AGE[1:10] <- NA
#' nrow(clean_brushedPoints(data, brush))
#'
#' @export
#'
clean_brushedPoints <- function(data, brush) { # nolint object_name_linter.
  checkmate::assert_data_frame(data)
  checkmate::assert_list(brush, null.ok = TRUE)

  # define original panelvar1 and panelvar2 before getting overwritten
  original_panelvar1 <- brush$mapping$panelvar1
  original_panelvar2 <- brush$mapping$panelvar2

  # Assign NULL to `mapping$panelvar1` and `mapping$panelvar1` if `brush$panelvar1` and `brush$panelvar1` are NULL
  # This will not evaluate the `panelMatch` step in `brushedPoints` and thus will return a non empty dataframe
  if (is.null(brush$panelvar1)) brush$mapping$panelvar1 <- NULL
  if (is.null(brush$panelvar2)) brush$mapping$panelvar2 <- NULL

  bp_df <- brushedPoints(data, brush)

  # Keep required rows only based on the value of `brush$panelvar1`
  df <- if (is.null(brush$panelvar1) && is.character(original_panelvar1) &&
    is.null(brush$panelvar2) && is.character(original_panelvar2)) {
    df_var1 <- bp_df[is.na(bp_df[[original_panelvar1]]), ]
    df_var1[is.na(df_var1[[original_panelvar2]]), ]
  } else if (is.null(brush$panelvar1) && is.character(original_panelvar1)) {
    bp_df[is.na(bp_df[[original_panelvar1]]), ]
  } else if (is.null(brush$panelvar2) && is.character(original_panelvar2)) {
    bp_df[is.na(bp_df[[original_panelvar2]]), ]
  } else {
    bp_df
  }

  # filter out rows that are only NAs
  df <- df[rowSums(is.na(df)) != ncol(df), ]
  df
}

#' @keywords internal
#'
get_plot_dpi <- function() {
  default_dpi <- 72
  dpi <- getOption("teal.plot_dpi", default_dpi)
  if (!checkmate::test_integerish(dpi, lower = 24, any.missing = FALSE, len = 1)) {
    warning(paste("Invalid value for option 'teal.plot_dpi', therefore defaulting to", default_dpi, "dpi"))
    dpi <- default_dpi
  }
  dpi
}

#' Print plot for download functionality
#'
#' @param plot (`reactive`)\cr
#'  reactive expression to draw a plot
#' @param plot_type (`reactive`)\cr
#'  reactive plot type (`gg`, `trel`, `grob`, `other`)
#'
#' @return Nothing returned, the plot is printed.
#' @keywords internal
#'
print_plot <- function(plot, plot_type) {
  switch(plot_type(),
    "grob" = grid::grid.draw(plot()),
    "other" = {
      graphics::plot.new()
      graphics::text(
        x = graphics::grconvertX(0.5, from = "npc"),
        y = graphics::grconvertY(0.5, from = "npc"),
        labels = "This plot graphic type is not yet supported to download"
      )
    },
    "base" = plot(),
    print(plot())
  )
}

#' @keywords internal
#' @noRd
table_with_settings_deps <- function() {
  htmltools::htmlDependency(
    name = "teal-widgets-table-with-settings",
    version = utils::packageVersion("teal.widgets"),
    package = "teal.widgets",
    src = "table-with-settings",
    stylesheet = "table-with-settings.css"
  )
}

#' @name table_with_settings
#'
#' @title `table_with_settings` module
#'
#' @description `r lifecycle::badge("stable")`\cr
#' Module designed to create a `shiny` table output based on `rtable` object (`ElementaryTable` or `TableTree`) input.
#' @inheritParams shiny::moduleServer
#' @param ... (`character`)\cr
#'  Useful for providing additional HTML classes for the output tag.
#'
#' @rdname table_with_settings
#' @export
#'
table_with_settings_ui <- function(id, ...) {
  checkmate::assert_string(id)

  ns <- NS(id)

  tags$div(
    table_with_settings_deps(),
    shinyjs::useShinyjs(),
    bslib::card(
      id = ns("table-with-settings"),
      full_screen = TRUE,
      tags$div(
        class = "teal-widgets settings-buttons",
        bslib::tooltip(
          trigger = tags$div(type_download_ui_table(ns("downbutton"))),
          options = list(trigger = "hover"),
          class = "download-button",
          "Download"
        )
      ),
      tags$div(
        class = "teal-widgets table-content",
        uiOutput(ns("table_out_main"), width = "100%", ...)
      )
    )
  )
}

#' @inheritParams shiny::moduleServer
#' @param table_r (`reactive`)\cr
#'  reactive expression that yields an `rtable` object (`ElementaryTable` or `TableTree`)
#' @param show_hide_signal (`reactive logical`) optional\cr
#'  mechanism to allow modules which call this module to show/hide the table_with_settings UI.
#'
#' @rdname table_with_settings
#'
#' @return A `shiny` module.
#'
#' @export
#'
#' @examples
#' library(shiny)
#' library(rtables)
#' library(magrittr)
#'
#' ui <- bslib::page_fluid(
#'   table_with_settings_ui(
#'     id = "table_with_settings"
#'   )
#' )
#'
#' server <- function(input, output, session) {
#'   table_r <- reactive({
#'     l <- basic_table() %>%
#'       split_cols_by("ARM") %>%
#'       analyze(c("SEX", "AGE"))
#'
#'     tbl <- build_table(l, DM)
#'
#'     tbl
#'   })
#'
#'   table_with_settings_srv(id = "table_with_settings", table_r = table_r)
#' }
#'
#' if (interactive()) {
#'   shinyApp(ui, server)
#' }
#'
table_with_settings_srv <- function(id, table_r, show_hide_signal = reactive(TRUE)) {
  checkmate::assert_class(table_r, c("reactive", "function"))
  checkmate::assert_class(show_hide_signal, c("reactive", "function"))

  if (!requireNamespace("rtables", quietly = TRUE)) {
    stop("package rtables is required, please install")
  }

  moduleServer(id, function(input, output, session) {
    ns <- session$ns
    # Turn on and off the UI
    observeEvent(show_hide_signal(), {
      if (show_hide_signal()) {
        shinyjs::show("table-with-settings")
      } else {
        shinyjs::hide("table-with-settings")
      }
    })

    output$table_out_main <- output$table_out_modal <- renderUI({
      rtables::as_html(table_r())
    })

    type_download_srv_table(
      id = "downbutton",
      table_reactive = table_r
    )
  })
}

type_download_ui_table <- function(id) {
  ns <- NS(id)
  bslib::popover(
    icon("download"),
    tags$div(
      radioButtons(ns("file_format"),
        label = "File type",
        choices = c("formatted txt" = ".txt", "csv" = ".csv", "pdf" = ".pdf"),
      ),
      textInput(ns("file_name"),
        label = "File name (without extension)",
        value = paste0("table_", strftime(Sys.time(), format = "%Y%m%d_%H%M%S"))
      ),
      conditionalPanel(
        condition = paste0("input['", ns("file_format"), "'] != '.csv'"),
        tags$div(
          class = "lock-btn",
          title = "on / off",
          shinyWidgets::prettyToggle(
            ns("pagination_switch"),
            value = FALSE,
            label_on = NULL,
            label_off = NULL,
            status_on = "default",
            status_off = "default",
            outline = FALSE,
            plain = TRUE,
            icon_on = icon("fas fa-toggle-off"),
            icon_off = icon("fas fa-toggle-on"),
            animation = "pulse"
          )
        ),
        tags$div(
          class = "paginate-ui",
          shinyWidgets::numericInputIcon(
            inputId = ns("lpp"),
            label = "Paginate table:",
            value = 70,
            icon = list("lines / page")
          ),
          uiOutput(ns("lpp_warning"))
        )
      ),
      conditionalPanel(
        condition = paste0("input['", ns("file_name"), "'] != ''"),
        downloadButton(ns("data_download"), label = character(0), class = "btn-sm w-full")
      )
    )
  )
}

type_download_srv_table <- function(id, table_reactive) {
  moduleServer(
    id,
    function(input, output, session) {
      observeEvent(input$pagination_switch, {
        if (input$pagination_switch) {
          shinyjs::enable("lpp")
        } else {
          shinyjs::disable("lpp")
        }
      })

      output$lpp_warning <- renderUI({
        catch_warning <- if (input$file_format != ".csv" && input$pagination_switch) {
          try(rtables::paginate_table(
            tt = table_reactive(),
            lpp = as.numeric(input$lpp)
          ), silent = TRUE)
        }

        if (inherits(catch_warning, "try-error")) {
          helpText(
            class = "error",
            icon("triangle-exclamation"),
            "Maximum lines per page includes the reprinted header. Please enter a numeric value or increase the value."
          )
        }
      })

      output$data_download <- downloadHandler(
        filename = function() {
          paste0(input$file_name, input$file_format)
        },
        content = function(file) {
          if (input$file_format == ".txt") {
            rtables::export_as_txt(
              x = table_reactive(),
              file = file,
              paginate = input$pagination_switch,
              lpp = if (input$pagination_switch) as.numeric(input$lpp)
            )
          } else if (input$file_format == ".csv") {
            result <- rtables::matrix_form(table_reactive())$strings
            utils::write.table(
              x = result,
              file = file,
              sep = ",",
              col.names = FALSE,
              row.names = TRUE,
              append = FALSE
            )
          } else {
            rtables::export_as_pdf(
              x = table_reactive(),
              file = file,
              paginate = input$pagination_switch,
              lpp = if (input$pagination_switch) as.numeric(input$lpp)
            )
          }
        }
      )
    }
  )
}

#' @keywords internal
#' @noRd
draggable_buckets_deps <- function() {
  htmltools::htmlDependency(
    name = "teal-widgets-draggable-buckets",
    version = utils::packageVersion("teal.widgets"),
    package = "teal.widgets",
    src = "draggable-buckets",
    script = "draggable-buckets.js",
    stylesheet = "draggable-buckets.css"
  )
}

#' @title Draggable Buckets
#' @description  `r lifecycle::badge("experimental")`
#' A custom widget with draggable elements that can be put into buckets.
#'
#' @param input_id (`character(1)`) the `HTML` id of this widget
#' @param label (`character(1)` or `shiny.tag`) the header of this widget
#' @param elements (`character`) the elements to drag into buckets
#' @param buckets (`character` or `list`) the names of the buckets the elements can be put in or a list of key-pair
#' values where key is a name of a bucket and value is a character vector of elements in a bucket
#'
#' @return the `HTML` code comprising an instance of this widget
#' @export
#'
#' @details `shinyvalidate` validation can be used with this widget. See example below.
#'
#' @examples
#' library(shiny)
#'
#' ui <- bslib::page_fluid(
#'   draggable_buckets("id", "Choices #1", c("a", "b"), c("bucket1", "bucket2")),
#'   draggable_buckets("id2", "Choices #2", letters, c("vowels", "consonants")),
#'   verbatimTextOutput("out"),
#'   verbatimTextOutput("out2")
#' )
#' server <- function(input, output) {
#'   iv <- shinyvalidate::InputValidator$new()
#'   iv$add_rule(
#'     "id",
#'     function(data) if (length(data[["bucket1"]]) == 0) "There should be stuff in bucket 1"
#'   )
#'   iv$enable()
#'
#'   observeEvent(list(input$id, input$id2), {
#'     print(isolate(input$id))
#'     print(isolate(input$id2))
#'   })
#'   output$out <- renderPrint({
#'     iv$is_valid()
#'     input$id
#'   })
#'   output$out2 <- renderPrint(input$id2)
#' }
#' if (interactive()) shinyApp(ui, server)
#'
#' # With default elements in the bucket
#' ui <- bslib::page_fluid(
#'   draggable_buckets("id", "Choices #1", c("a", "b"), list(bucket1 = character(), bucket2 = c("c"))),
#'   verbatimTextOutput("out")
#' )
#' server <- function(input, output) {
#'   observeEvent(input$id, {
#'     print(isolate(input$id))
#'   })
#'   output$out <- renderPrint(input$id)
#' }
#' if (interactive()) shinyApp(ui, server)
draggable_buckets <- function(input_id, label, elements = character(), buckets) {
  checkmate::assert_string(input_id)
  checkmate::assert_true(inherits(label, "character") || inherits(label, "shiny.tag"))
  checkmate::assert_character(c(elements, unlist(buckets)), min.len = 0, null.ok = TRUE, unique = TRUE)
  checkmate::assert(
    checkmate::check_character(buckets, min.len = 1),
    checkmate::check_list(buckets, types = "character", names = "unique")
  )

  elements_iterator <- new.env(parent = emptyenv())
  elements_iterator$it <- 0

  shiny::tagList(
    draggable_buckets_deps(),
    shiny::div(
      tags$span(label),
      render_unbucketed_elements(elements = elements, elements_iterator = elements_iterator, widget_id = input_id),
      render_buckets(buckets = buckets, elements_iterator = elements_iterator, widget_id = input_id),
      class = "draggableBuckets",
      id = input_id
    )
  )
}

render_unbucketed_elements <- function(elements, elements_iterator, widget_id) {
  tags$div(
    lapply(elements, function(element) {
      elements_iterator$it <- elements_iterator$it + 1
      render_draggable_element(
        value = element,
        id = paste0(widget_id, "draggable", elements_iterator$it),
        widget_id = widget_id
      )
    }),
    id = paste0(widget_id, "elements"),
    class = c("form-control", "elements"),
    ondragover = "allowDrop(event)",
    ondrop = "drop(event)",
    `data-widget` = widget_id
  )
}

render_buckets <- function(buckets, elements_iterator, widget_id) {
  buckets <- `if`(
    is.list(buckets),
    lapply(names(buckets), function(bucket_name) {
      render_bucket(
        name = bucket_name,
        elements = buckets[[bucket_name]],
        elements_iterator = elements_iterator,
        widget_id = widget_id
      )
    }),
    lapply(buckets, render_bucket, widget_id = widget_id, elements_iterator = elements_iterator)
  )
  shiny::tagList(buckets)
}

render_draggable_element <- function(value, id, widget_id) {
  tags$div(
    value,
    id = id,
    class = "element",
    draggable = "true",
    ondragstart = "drag(event)",
    ondragover = "allowDrop(event)",
    ondrop = "dropReorder(event)",
    `data-widget` = widget_id
  )
}

render_bucket <- function(name, elements = NULL, elements_iterator = NULL, widget_id = NULL) {
  tags$div(
    tags$div(
      paste0(name, ":"),
      class = "bucket-name",
      ondragover = "allowDrop(event)",
      ondrop = "dropBucketName(event)",
      `data-widget` = widget_id
    ),
    lapply(elements, function(element) {
      elements_iterator$it <- elements_iterator$it + 1
      render_draggable_element(
        value = element,
        id = paste0(widget_id, "draggable", elements_iterator$it),
        widget_id = widget_id
      )
    }),
    class = c("form-control", "bucket"),
    ondragover = "allowDrop(event)",
    ondrop = "drop(event)",
    `data-label` = name,
    `data-widget` = widget_id
  )
}

#' This function checks the plot type and applies specific modifications
#' to the plot object based on the provided parameters.
#'
#' @param plot_obj The original plot object.
#' @param plot_type The type of the plot, either `gg` (`ggplot2`) or `grob` (`grid`, `graphics`).
#' @param dblclicking A logical value indicating whether double-clicking on data points on
#' the main plot is enabled or disabled.
#' @param ranges A list containing x and y values of ranges.
#'
#' @keywords internal
apply_plot_modifications <- function(plot_obj, plot_type, dblclicking, ranges) {
  if (plot_type == "gg" && dblclicking) {
    plot_obj +
      ggplot2::coord_cartesian(xlim = ranges$x, ylim = ranges$y, expand = FALSE)
  } else if (plot_type == "grob") {
    grid::grid.newpage()
    grid::grid.draw(plot_obj)
  } else {
    plot_obj
  }
}

#' This function opens a PDF graphics device using [grDevices::pdf()] to suppress
#' the plot display in the IDE. The purpose of this function is to avoid opening graphic devices
#' directly in the IDE.
#'
#' @param x lazy binding which generates the plot(s)
#'
#' @keywords internal
plot_suppress <- function(x) {
  grDevices::pdf(nullfile())
  on.exit(grDevices::dev.off())
  force(x)
}

#' Panel group widget
#'
#' @description `r lifecycle::badge("deprecated")`\cr
#' Designed to group [`panel_item`] elements. Used to handle `shiny` inputs in the encoding panel.
#' @param id optional, (`character`)\cr
#' @param ... (`shiny.tag`)\cr
#'  panels created by [panel_group()]
#'
#' @return (`shiny.tag`)
#'
#' @examples
#'
#' library(shiny)
#' panel_group(
#'   panel_item(
#'     title = "Display",
#'     collapsed = FALSE,
#'     checkboxGroupInput(
#'       "check",
#'       "Tables display",
#'       choices = LETTERS[1:3],
#'       selected = LETTERS[1]
#'     ),
#'     radioButtons(
#'       "radio",
#'       label = "Plot type",
#'       choices = letters[1:2],
#'       selected = letters[1]
#'     )
#'   ),
#'   panel_item(
#'     title = "Pre-processing",
#'     radioButtons(
#'       "filtering",
#'       "What to filter",
#'       choices = LETTERS[1:4],
#'       selected = LETTERS[1]
#'     ),
#'     radioButtons(
#'       "na_action",
#'       "NA action",
#'       choices = letters[1:3],
#'       selected = letters[1]
#'     )
#'   )
#' )
#'
#' @export
panel_group <- function(..., id = NULL) {
  lifecycle::deprecate_soft(
    when = "0.4.3",
    what = "panel_group()",
    details = paste(
      "The `panel_group()` and `panel_item()` view can be achieved by using the `bslib` package.",
      "Please use the `bslib::accordion()` and `bslib::accordion_panel()` functions instead.",
      "This function will be removed in the next release."
    )
  )
  checkmate::assert_string(id, null.ok = TRUE)

  # panel-group
  # div

  bslib::accordion(
    ...
  )
}

#' @keywords internal
#' @noRd
panel_item_deps <- function() {
  htmltools::htmlDependency(
    name = "teal-widgets-panel-item",
    version = utils::packageVersion("teal.widgets"),
    package = "teal.widgets",
    src = "panel-item",
    script = "panel-item.js",
    stylesheet = "panel-item.css"
  )
}

#' Panel item widget
#'
#' @description `r lifecycle::badge("deprecated")`\cr
#' Designed to be grouped using [`panel_group`] element. Used to handle `shiny` inputs in the encoding panel.
#' @param title (`character`)\cr title of panel
#' @param ... content of panel
#' @param collapsed (`logical`) optional,\cr
#'  whether to initially collapse panel
#' @param input_id (`character`) optional\cr
#'  name of the panel item element. If supplied, this will register a shiny input variable that
#'  indicates whether the panel item is open or collapsed and is accessed with `input$input_id`.
#'
#' @return (`shiny.tag`)
#'
#' @examples
#'
#' library(shiny)
#' panel_item(
#'   title = "Display",
#'   collapsed = FALSE,
#'   checkboxGroupInput(
#'     "check",
#'     "Tables display",
#'     choices = LETTERS[1:3],
#'     selected = LETTERS[1]
#'   ),
#'   radioButtons(
#'     "radio",
#'     label = "Plot type",
#'     choices = letters[1:2],
#'     selected = letters[1]
#'   )
#' )
#'
#' @export
panel_item <- function(title, ..., collapsed = TRUE, input_id = NULL) {
  lifecycle::deprecate_soft(
    when = "0.4.3",
    what = "panel_item()",
    details = paste(
      "The `panel_group()` and `panel_item()` view can be achieved by using the `bslib` package.",
      "Please use the `bslib::accordion()` and `bslib::accordion_panel()` functions instead.",
      "This function will be removed in the next release."
    )
  )
  stopifnot(checkmate::test_character(title, len = 1) || inherits(title, c("shiny.tag", "shiny.tag.list", "html")))
  checkmate::assert_flag(collapsed)
  checkmate::assert_string(input_id, null.ok = TRUE)

  bslib::accordion_panel(
    id = input_id,
    title = title,
    open = !collapsed,
    ...
  )
}

#' @keywords internal
#' @noRd
standard_layout_deps <- function() {
  htmltools::htmlDependency(
    name = "teal-widgets-standard-layout",
    version = utils::packageVersion("teal.widgets"),
    package = "teal.widgets",
    src = "standard-layout",
    stylesheet = "standard-layout.css"
  )
}

#' Standard UI layout
#'
#' @description `r lifecycle::badge("stable")`\cr
#' Create a standard UI layout with output on the right and an encoding panel on
#' the left. This is the layout used by the `teal` modules.
#'
#' @param output (`shiny.tag`)\cr
#'   object with the output element (table, plot, listing) such as for example returned
#' by [shiny::plotOutput()].
#' @param encoding (`shiny.tag`)\cr
#'  object containing the encoding elements. If this element is `NULL` then no encoding side
#'  panel on the right is  created.
#' @param forms (`tagList`)\cr
#'  for example [shiny::actionButton()] that are placed below the encodings panel
#' @param pre_output (`shiny.tag`) optional,\cr
#'  with text placed before the output to put the output into context. For example a title.
#' @param post_output (`shiny.tag`) optional, with text placed after the output to put the output
#' into context. For example the [shiny::helpText()] elements are useful.
#'
#' @return an object of class `shiny.tag` with the UI code.
#'
#' @examples
#' library(shiny)
#' standard_layout(
#'   output = white_small_well(tags$h3("Tests")),
#'   encoding = tags$div(
#'     tags$label("Encodings", class = "text-primary"),
#'     panel_item(
#'       "Tests",
#'       optionalSelectInput(
#'         "tests",
#'         "Tests:",
#'         choices = c(
#'           "Shapiro-Wilk",
#'           "Kolmogorov-Smirnov (one-sample)"
#'         ),
#'         selected = "Shapiro-Wilk"
#'       )
#'     )
#'   ),
#'   forms = tagList(
#'     verbatim_popup_ui("warning", "Show Warnings"),
#'     verbatim_popup_ui("rcode", "Show R code")
#'   )
#' )
#'
#' @export
standard_layout <- function(output,
                            encoding = NULL,
                            forms = NULL,
                            pre_output = NULL,
                            post_output = NULL) {
  # checking arguments
  checkmate::assert_multi_class(output, c("shiny.tag", "shiny.tag.list", "html"))
  checkmate::assert_multi_class(encoding, c("shiny.tag", "shiny.tag.list", "html"), null.ok = TRUE)
  checkmate::assert_multi_class(pre_output, c("shiny.tag", "shiny.tag.list", "html"), null.ok = TRUE)
  checkmate::assert_multi_class(post_output, c("shiny.tag", "shiny.tag.list", "html"), null.ok = TRUE)

  # if encoding=NULL then forms is placed below output

  tag_output <- tags$div(
    class = "teal-widgets standard-layout",
    tags$div(class = "standard-layout-pre-output", pre_output),
    tags$div(class = "standard-layout-output", output),
    tags$div(class = "standard-layout-post-output", post_output)
  )

  tag_enc_out <- if (!is.null(encoding)) {
    tags$div(
      class = "teal-widgets standard-layout has-encodings",
      bslib::layout_sidebar(
        sidebar = bslib::sidebar(
          tags$div(
            encoding,
            if (is.null(forms)) {
              NULL
            } else {
              tags$div(
                tags$br(),
                forms
              )
            }
          )
        ),
        tag_output
      )
    )
  } else {
    tags$div(
      tag_output,
      if (is.null(forms)) {
        NULL
      } else {
        tags$div(class = "form-group", forms)
      }
    )
  }

  bslib::page_fluid(
    class = "teal-widgets standard-layout-wrapper",
    standard_layout_deps(),
    tag_enc_out
  )
}

#' Builds a `basic_table_args` object
#'
#' @description `r lifecycle::badge("experimental")`
#' This function has to be used to build an input for a `basic_table_args` argument.
#' The `basic_table_args` argument should be a part of every module which contains any `rtables` object.
#' Arguments are validated to match their `rtables` equivalents.
#'
#' For more details see the vignette: `vignette("custom-basic-table-arguments", package = "teal.widgets")`.
#'
#' @seealso
#' * [resolve_basic_table_args()] to resolve multiple objects into one using pre-defined priorities.
#' * [parse_basic_table_args()] to parse resolved list into list of calls.
#'
#' @param ... arguments compatible with [rtables::basic_table()].
#'
#' @return (`basic_table_args`) object.
#' @export
#' @examples
#' basic_table_args(subtitles = "SUBTITLE")
basic_table_args <- function(...) {
  table_args_l <- list(...)
  checkmate::assert_character(names(table_args_l), unique = TRUE, null.ok = TRUE)

  basic_table_formals <- methods::formalArgs(rtables::basic_table)
  checkmate::assert_subset(names(table_args_l), choices = basic_table_formals, empty.ok = TRUE)

  structure(table_args_l, class = "basic_table_args")
}

#' Resolves and reduces multiple `basic_table_args` objects
#'
#' @description `r lifecycle::badge("experimental")`
#' Resolving and reducing multiple `basic_table_args` objects.
#' This function is intended to utilize user provided settings, defaults provided by the module creator and
#' also `teal` option. See `Details`, below, to understand the logic.
#'
#' @seealso [parse_basic_table_args()] to parse resolved list into list of calls.
#'
#' @param user_table (`basic_table_args`)\cr
#'  end user setup for [rtables::basic_table()] of a specific table.
#'  Created with the [basic_table_args()] function. The `NULL` value is supported.
#' @param user_default (`basic_table_args`)\cr
#'  end user default setup for [rtables::basic_table()]
#'  of a specific table. Created with the [basic_table_args()] function. The `NULL` value is supported.
#' @param module_table (`ggplot2_args`)\cr
#'  module creator setup for [rtables::basic_table()] of a specific table.
#'  Created with the [basic_table_args()] function. The `NULL` value is supported.
#' @param app_default (`basic_table_args`)\cr
#'  Application level setting. Can be `NULL`.
#'
#' @return `basic_table_args` object.
#' @details
#' The function picks the first non `NULL` value for each argument, checking in the following order:
#' 1. `basic_table_args` argument provided by the end user.
#' Per table (`user_table`) and then default (`user_default`) setup.
#' 2. `app_default` global R variable, `teal.basic_table_args`.
#' 3. `module_table` which is a module creator setup.
#' @export
#' @examples
#' resolve_basic_table_args(
#'   user_table = basic_table_args(title = "TITLE"),
#'   user_default = basic_table_args(title = "DEFAULT_TITLE", subtitles = "SUBTITLE")
#' )
resolve_basic_table_args <- function(user_table = basic_table_args(),
                                     user_default = basic_table_args(),
                                     module_table = basic_table_args(),
                                     app_default = getOption("teal.basic_table_args", basic_table_args())) {
  checkmate::assert_class(user_table, "basic_table_args", null.ok = TRUE)
  checkmate::assert_class(user_default, "basic_table_args", null.ok = TRUE)
  checkmate::assert_class(module_table, "basic_table_args", null.ok = TRUE)
  checkmate::assert_class(app_default, "basic_table_args", null.ok = TRUE)

  table_args_all <- list(
    "table" = user_table,
    "default" = user_default,
    "teal" = app_default,
    "module" = module_table
  )

  table_args_f <- Reduce(`c`, table_args_all)

  if (length(table_args_f) == 0) {
    basic_table_args()
  } else {
    do.call(basic_table_args, table_args_f[!duplicated(names(table_args_f))])
  }
}

#' Parses `basic_table_args` object into the `basic_table` expression
#'
#' @description `r lifecycle::badge("experimental")`
#' A function to parse expression from the `basic_table_args` object.
#' @param basic_table_args (`basic_table_args`)\cr
#'  This argument could be a result of the [`resolve_basic_table_args()`].
#'
#' @return (`language`) the `rtables::basic_table()` filled with additional arguments.
#' @export
#' @examples
#' parse_basic_table_args(
#'   resolve_basic_table_args(
#'     user_table = basic_table_args(title = "TITLE"),
#'     user_default = basic_table_args(title = "DEFAULT_TITLE", subtitles = "SUBTITLE")
#'   )
#' )
parse_basic_table_args <- function(basic_table_args = teal.widgets::basic_table_args()) {
  checkmate::assert_class(basic_table_args, "basic_table_args", null.ok = TRUE)

  if (length(basic_table_args) == 0) {
    quote(rtables::basic_table())
  } else {
    as.call(c(list(quote(rtables::basic_table)), basic_table_args))
  }
}

#' Map `lenghtMenu` property
#'
#' @description `r lifecycle::badge("stable")`\cr
#' Maps the `lengthMenu` selected value property of `DT::datatable` to a `shiny` variable.
#' @param dt_name `ns()` of `inputId` of the `DT::datatable`
#' @param dt_rows `ns()` of `inputId` of the variable that holds the current selected value of `lengthMenu`
#'
#' @name get_dt_rows
#'
#' @return (`shiny::tagList`) A `shiny tagList`.
#'
#' @examplesIf require("DT")
#' library(shiny)
#' library(DT)
#'
#' ui <- function(id) {
#'   ns <- NS(id)
#'   tagList(
#'     DTOutput(ns("data_table")),
#'     get_dt_rows(ns("data_table"), ns("dt_rows"))
#'   )
#' }
#'
#' # use the input$dt_rows in the Shiny Server function
#' server <- function(id) {
#'   moduleServer(id, function(input, output, session) {
#'     output$data_table <- renderDataTable(
#'       {
#'         iris
#'       },
#'       options = list(pageLength = input$dt_rows)
#'     )
#'   })
#' }
#'
#' if (interactive()) {
#'   shinyApp(
#'     ui = ui("my_table_module"),
#'     server = function(input, output, session) server("my_table_module")
#'   )
#' }
#' @export
get_dt_rows <- function(dt_name, dt_rows) {
  tags$head(
    tags$script(
      sprintf(
        "$(document).ready(function() {
        $('%s').on('length.dt', function(e, settings, len) {
        Shiny.onInputChange('%s', len);
        });
        });",
        paste0("#", dt_name),
        dt_rows
      )
    )
  )
}

#' Small well class for HTML
#'
#' @description `r lifecycle::badge("stable")`\cr
#' Adds Small Well class and overflow-x property to HTML output element.
#' @param ... other arguments to pass to tag object's div attributes.
#'
#' @details `white_small_well` is intended to be used with [shiny::uiOutput()].
#' The overflow-x property is set to auto so that a scroll bar is added
#' when the content overflows at the left and right edges of the output window.
#' For example, this is useful for displaying wide tables.
#'
#' @return An HTML output element with class Small Well and overflow-x property
#' @export
#'
#' @examples
#'
#' white_small_well(shiny::htmlOutput("summary"))
white_small_well <- function(...) {
  shiny::tagList(
    tags$div(
      class = "well well-sm",
      style = "background-color: white;",
      ...
    )
  )
}

1		#' @keywords internal
2		#' @noRd
3		verbatim_popup_deps <- function() {
4	4x	htmltools::htmlDependency(
5	4x	name = "teal-widgets-verbatim-popup",
6	4x	version = utils::packageVersion("teal.widgets"),
7	4x	package = "teal.widgets",
8	4x	src = "verbatim-popup",
9	4x	script = "verbatim-popup.js"
10		)
11		}
12
13		#' A `shiny` module that pops up verbatim text.
14		#' @name verbatim_popup
15		#' @description `r lifecycle::badge("experimental")`
16		#' This module consists of a button that once clicked pops up a
17		#' modal window with verbatim-styled text.
18		#'
19		#' @param id (`character(1)`) the `shiny` id
20		#' @param button_label (`character(1)`) the text printed on the button
21		#' @param type (`character(1)`) specifying whether to use `[shiny::actionButton()]` or `[shiny::actionLink()]`.
22		#' @param ... additional arguments to `[shiny::actionButton()]`(or `[shiny::actionLink()]`).
23		#'
24		#' @return the UI function returns a `shiny.tag.list` object
25		#' @export
26		#'
27		#' @examples
28		#' library(shiny)
29		#'
30		#' ui <- bslib::page_fluid(verbatim_popup_ui("my_id", button_label = "Open popup"))
31		#' srv <- function(input, output) {
32		#' verbatim_popup_srv(
33		#' "my_id",
34		#' "if (TRUE) { print('Popups are the best') }",
35		#' title = "My custom title",
36		#' style = TRUE
37		#' )
38		#' }
39		#' if (interactive()) shinyApp(ui, srv)
40		#'
41		verbatim_popup_ui <- function(id, button_label, type = c("button", "link"), ...) {
42	5x	checkmate::assert_string(id)
43	5x	checkmate::assert_string(button_label)
44
45	5x	ui_function <- switch(match.arg(type),
46	5x	"button" = shiny::actionButton,
47	5x	"link" = shiny::actionLink
48		)
49
50	4x	ns <- shiny::NS(id)
51	4x	ui_args <- list(
52	4x	inputId = ns("button"),
53	4x	label = button_label
54		)
55
56	4x	shiny::tagList(
57	4x	verbatim_popup_deps(),
58	4x	shinyjs::useShinyjs(),
59	4x	do.call(ui_function, c(ui_args, list(...)))
60		)
61		}
62
63		#' @name verbatim_popup
64		#' @export
65		#'
66		#' @param verbatim_content (`character`, `expression`, `condition` or `reactive(1)`
67		#' holding any of the above) the content to show in the popup modal window
68		#' @param title (`character(1)`) the title of the modal window
69		#' @param style (`logical(1)`) whether to style the `verbatim_content` using `styler::style_text`.
70		#' If `verbatim_content` is a `condition` or `reactive` holding `condition` then this argument is ignored
71		#' @param disabled (`reactive(1)`) the `shiny` reactive value holding a `logical`. The popup button is disabled
72		#' when the flag is `TRUE` and enabled otherwise.
73		#'
74		verbatim_popup_srv <- function(id, verbatim_content, title, style = FALSE, disabled = shiny::reactiveVal(FALSE)) {
75	!	checkmate::assert_string(id)
76	!	checkmate::assert_string(title)
77	!	checkmate::assert_flag(style)
78	!	checkmate::assert_class(disabled, classes = "reactive")
79	!	moduleServer(id, function(input, output, session) {
80	!	ns <- session$ns
81	!	modal_content <- format_content(verbatim_content, style)
82	!	button_click_observer(
83	!	click_event = shiny::reactive(input$button),
84	!	copy_button_id = ns("copy_button"),
85	!	copied_area_id = ns("verbatim_content"),
86	!	modal_title = title,
87	!	modal_content = modal_content,
88	!	disabled = disabled
89		)
90		})
91		}
92
93		#' Creates a `shiny` observer handling button clicks.
94		#'
95		#' @description
96		#' When the button is clicked it pop up a modal window with the text.
97		#'
98		#' @keywords internal
99		#' @param click_event `reactive` the click event
100		#' @param copy_button_id (`character(1)`) the id of the button to copy the modal content.
101		#' Automatically appended with a 1 and 2 suffix for top and bottom buttons respectively.
102		#' @param copied_area_id (`character(1)`) the id of the element which contents are copied
103		#' @param modal_title (`character(1)`) the title of the modal window
104		#' @param modal_content (`reactive`) the content of the modal window
105		#' @param disabled (`reactive(1)`) the `shiny` reactive value holding a `logical`. The popup button is disabled
106		#' when the flag is `TRUE` and enabled otherwise.
107		button_click_observer <- function(click_event,
108		copy_button_id,
109		copied_area_id,
110		modal_title,
111		modal_content,
112		disabled) {
113	1x	shiny::observeEvent(
114	1x	disabled(),
115	1x	handlerExpr = {
116	!	if (disabled()) {
117	!	shinyjs::disable("button")
118		} else {
119	!	shinyjs::enable("button")
120		}
121		}
122		)
123
124	1x	shiny::observeEvent(
125	1x	click_event(),
126	1x	handlerExpr = {
127	!	req(modal_content())
128	!	shiny::showModal(
129	!	div(
130	!	class = "teal-widgets button-click-observer",
131	!	shiny::modalDialog(
132	!	tags$div(
133	!	tags$div(
134	!	shiny::actionButton(
135	!	paste0(copy_button_id, 1),
136	!	"Copy to Clipboard",
137	!	onclick = paste0("copyToClipboard('", copied_area_id, "')")
138		),
139	!	shiny::modalButton("Dismiss")
140		),
141	!	tags$pre(id = copied_area_id, modal_content()),
142		),
143	!	title = modal_title,
144	!	footer = shiny::tagList(
145	!	shiny::actionButton(
146	!	paste0(copy_button_id, 2),
147	!	"Copy to Clipboard",
148	!	onclick = paste0("copyToClipboard('", copied_area_id, "')")
149		),
150	!	shiny::modalButton("Dismiss")
151		),
152	!	size = "l",
153	!	easyClose = TRUE
154		)
155		)
156		)
157		}
158		)
159		}
160
161		#' Formats the content of the modal popup window.
162		#'
163		#' @details
164		#' Formats the content:
165		#' * concatenates if needed
166		#' * styles if `style` is TRUE
167		#'
168		#' @keywords internal
169		#' @inheritParams verbatim_popup
170		#' @return `reactive` with the formatted content
171		format_content <- function(verbatim_content, style = FALSE) {
172	11x	shiny::reactive({
173	4x	content <- if (inherits(verbatim_content, "reactive")) {
174	2x	tryCatch(
175	2x	verbatim_content(),
176	2x	error = function(e) {
177	!	e
178		}
179		)
180		} else {
181	2x	verbatim_content
182		}
183	4x	shiny::validate(shiny::need(
184	4x	checkmate::test_multi_class(content, classes = c("expression", "character", "condition")),
185	4x	"verbatim_content should be an expression, character or condition"
186		))
187
188	4x	content <- paste(as.character(content), collapse = "\n")
189
190	4x	if (style && !checkmate::test_class(content, "condition")) {
191	3x	content <- paste(styler::style_text(content), collapse = "\n")
192		}
193	4x	content
194		})
195		}

1		#' Nested Closeable Modal Popup
2		#'
3		#' @description `r lifecycle::badge("experimental")`
4		#' Alternative to `shiny::modalDialog`. Create a nested modal popup that can be shown/hidden
5		#' using `jQuery` and modal `id`, without disturbing the parent modal.
6		#'
7		#' @param id (`character(1)`) `shiny` module id for the component.\cr
8		#' Note that this id can be used to show/hide this modal
9		#' with the appended `jQuery` methods show/hide.
10		#' @param ... (`shiny.tag`) `shiny` UI elements that will be displayed in the modal UI
11		#' @param modal_args (`list`) optional list of arguments for the `shiny::modalDialog` function
12		#' to customize the modal. Has `easyClose` set to `TRUE` as default
13		#'
14		#' @return (`shiny.tag`) returns `HTML` for `shiny` module UI which can be nested into a modal popup
15		#' @export
16		#'
17		#' @examples
18		#' library(shiny)
19		#' library(shinyjs)
20		#'
21		#' ui <- bslib::page_fluid(
22		#' useShinyjs(),
23		#' actionButton("show_1", "$(\"#modal_1\").modal(\"show\")"),
24		#' nested_closeable_modal(
25		#' "modal_1",
26		#' modal_args = list(
27		#' size = "l",
28		#' title = "First Modal",
29		#' easyClose = TRUE,
30		#' footer = NULL
31		#' ),
32		#' tags$div(
33		#' "This modal can be closed by running", tags$code("$(\"#modal_1\").modal(\"hide\")"),
34		#' "in the JS console!",
35		#' tags$br(),
36		#' "Note that the second modal is placed right within this modal",
37		#' tags$br(),
38		#' "Alternatively, calling the", tags$code("removeModal()"),
39		#' "will remove all the active modal popups",
40		#' tags$br(), tags$br(),
41		#' actionButton("show_2", "$(\"#modal_2\").modal(\"show\")"),
42		#' actionButton("hide_1", "$(\"#modal_1\").modal(\"hide\")"),
43		#' nested_closeable_modal(
44		#' id = "modal_2",
45		#' modal_args = list(
46		#' size = "m",
47		#' title = "Second Modal",
48		#' footer = NULL,
49		#' easyClose = TRUE
50		#' ),
51		#' tags$div(
52		#' "This modal can be closed by running", tags$code("$(\"#modal_1\").modal(\"hide\")"),
53		#' "in the JS console!",
54		#' "Note that removing the parent will remove the child.
55		#' But, reopening will remember the open state of child",
56		#' actionButton("hide_2", "$(\"#modal_2\").modal(\"hide\")"),
57		#' actionButton("hide_all", "$(\"#modal_1\").modal(\"hide\")")
58		#' )
59		#' )
60		#' )
61		#' )
62		#' )
63		#'
64		#' server <- function(input, output) {
65		#' observeEvent(input$show_1, {
66		#' runjs("$(\"#modal_1\").modal(\"show\")")
67		#' })
68		#' observeEvent(input$show_2, {
69		#' runjs("$(\"#modal_2\").modal(\"show\")")
70		#' })
71		#' observeEvent(c(input$hide_1, input$hide_all), {
72		#' runjs("$(\"#modal_1\").modal(\"hide\")")
73		#' })
74		#' observeEvent(input$hide_2, {
75		#' runjs("$(\"#modal_2\").modal(\"hide\")")
76		#' })
77		#' }
78		#'
79		#' if (interactive()) {
80		#' shinyApp(ui, server)
81		#' }
82		nested_closeable_modal <- function(id, ..., modal_args = list(easyClose = TRUE)) {
83	!	checkmate::assert_string(id)
84	!	checkmate::assert_list(modal_args)
85	!	modal_args <- append(list(...), modal_args)
86	!	tagList(
87	!	htmltools::tagQuery(do.call(modalDialog, modal_args))$
88	!	removeAttrs("id")$
89	!	addAttrs(id = id, `aria-hidden` = "true", class = "custom-modal", `data-backdrop` = "false")$
90	!	children("div")$
91	!	children("div")$
92	!	children("div")$
93	!	siblings(".modal-footer")$
94	!	find("button")$
95	!	removeAttrs(c("data-dismiss", "data-bs-dismiss"))$
96	!	addAttrs(onclick = paste0("$('#", id, "').modal('hide');"))$
97	!	allTags()
98		)
99		}

1		#' Creates `ggplot2_args` object
2		#'
3		#' @description `r lifecycle::badge("experimental")`
4		#' Constructor of `ggplot2_args` class of objects.
5		#' The `ggplot2_args` argument should be a part of every module which contains any `ggplot2` graphics.
6		#' The function arguments are validated to match their `ggplot2` equivalents.
7		#'
8		#' For more details see the vignette: `vignette("custom-ggplot2-arguments", package = "teal.widgets")`.
9		#'
10		#' @seealso
11		#' * [resolve_ggplot2_args()] to resolve multiple objects into one using pre-defined priorities.
12		#' * [parse_ggplot2_args()] to parse resolved list into list of calls.
13		#'
14		#' @param labs (named `list`)\cr
15		#' where all fields have to match [ggplot2::labs()] arguments.
16		#' @param theme (named `list`)\cr
17		#' where all fields have to match [ggplot2::theme()] arguments.
18		#'
19		#' @return (`ggplot2_args`) object.
20		#' @export
21		#' @examples
22		#' ggplot2_args(
23		#' labs = list(title = "TITLE"),
24		#' theme = list(title = ggplot2::element_text(size = 20))
25		#' )
26		ggplot2_args <- function(labs = list(), theme = list()) {
27	92x	checkmate::assert_list(labs)
28	92x	checkmate::assert_list(theme)
29	92x	checkmate::assert_character(names(labs), unique = TRUE, null.ok = TRUE)
30	92x	checkmate::assert_character(names(theme), unique = TRUE, null.ok = TRUE)
31
32	92x	ggplot2_theme <- methods::formalArgs(ggplot2::theme)
33		# utils::getFromNamespace is not recommended nevertheless needed as it is replacing `:::`.
34		# usage of static values will be vulnerable to any changes in ggplot2 aesthetics.
35	92x	ggplot2_labs <- c(
36	92x	utils::getFromNamespace(".all_aesthetics", "ggplot2"),
37	92x	methods::formalArgs(ggplot2::labs)
38		)
39	92x	checkmate::assert_subset(names(labs), choices = ggplot2_labs, empty.ok = TRUE)
40	91x	checkmate::assert_subset(names(theme), choices = ggplot2_theme, empty.ok = TRUE)
41
42	90x	structure(list(labs = labs, theme = theme), class = "ggplot2_args")
43		}
44
45		#' Resolving and reducing multiple `ggplot2_args` objects
46		#'
47		#' @description `r lifecycle::badge("experimental")`
48		#' Resolving and reducing multiple `ggplot2_args` objects.
49		#' This function is intended to utilize user provided settings, defaults provided by the module creator and
50		#' also `teal` option. See `Details`, below, to understand the logic.
51		#'
52		#' @seealso [parse_ggplot2_args()] to parse resolved list into list of calls.
53		#'
54		#' @param user_plot (`ggplot2_args`)\cr
55		#' end user setup for theme and labs in the specific plot.
56		#' Created with the [ggplot2_args()] function. The `NULL` value is supported.
57		#' @param user_default (`ggplot2_args`)\cr
58		#' end user setup for module default theme and labs.
59		#' Created with the [ggplot2_args()] function. The `NULL` value is supported.
60		#' @param module_plot (`ggplot2_args`)\cr
61		#' module creator setup for theme and labs in the specific plot.
62		#' Created with the [ggplot2_args()] function. The `NULL` value is supported.
63		#' @param app_default (`ggplot2_args`)\cr
64		#' Application level setting. Can be `NULL`.
65		#'
66		#' @return `ggplot2_args` object.
67		#'
68		#' @details
69		#' The function picks the first non `NULL` value for each argument, checking in the following order:
70		#' 1. `ggplot2_args` argument provided by the end user.
71		#' Per plot (`user_plot`) and then default (`user_default`) setup.
72		#' 2. `app_default` global R variable, `teal.ggplot2_args`.
73		#' 3. `module_plot` which is a module creator setup.
74		#' @export
75		#' @examples
76		#' resolve_ggplot2_args(
77		#' user_plot = ggplot2_args(
78		#' labs = list(title = "TITLE"),
79		#' theme = list(title = ggplot2::element_text(size = 20))
80		#' ),
81		#' user_default = ggplot2_args(
82		#' labs = list(x = "XLAB")
83		#' )
84		#' )
85		resolve_ggplot2_args <- function(user_plot = ggplot2_args(),
86		user_default = ggplot2_args(),
87		module_plot = ggplot2_args(),
88		app_default = getOption("teal.ggplot2_args", ggplot2_args())) {
89	18x	checkmate::assert_class(user_plot, "ggplot2_args", null.ok = TRUE)
90	17x	checkmate::assert_class(user_default, "ggplot2_args", null.ok = TRUE)
91	17x	checkmate::assert_class(module_plot, "ggplot2_args", null.ok = TRUE)
92	17x	checkmate::assert_class(app_default, "ggplot2_args", null.ok = TRUE)
93
94	17x	ggplot2_args_all <- list(
95	17x	"plot" = user_plot,
96	17x	"default" = user_default,
97	17x	"teal" = app_default,
98	17x	"module" = module_plot
99		)
100
101	17x	labs_args <- Reduce(`c`, lapply(ggplot2_args_all, function(x) x$labs))
102	17x	labs_args <- if (is.null(labs_args)) list() else labs_args[!duplicated(names(labs_args))]
103
104	17x	theme_args <- Reduce(`c`, lapply(ggplot2_args_all, function(x) x$theme))
105	17x	theme_args <- if (is.null(theme_args)) list() else theme_args[!duplicated(names(theme_args))]
106
107	17x	ggplot2_args(labs = labs_args, theme = theme_args)
108		}
109
110		#' Parse `ggplot2_args` object into the `ggplot2` expression
111		#'
112		#' @description `r lifecycle::badge("experimental")`
113		#' A function to parse expression from the `ggplot2_args` object.
114		#' @param ggplot2_args (`ggplot2_args`)\cr
115		#' This argument could be a result of the [resolve_ggplot2_args()].
116		#' @param ggtheme (`character(1)`)\cr
117		#' name of the `ggplot2` theme to be applied, e.g. `"dark"`.
118		#'
119		#' @return (`list`) of up to three elements of class `languange`: `"labs"`, `"ggtheme"` and `"theme"`.
120		#' @export
121		#' @examples
122		#' parse_ggplot2_args(
123		#' resolve_ggplot2_args(ggplot2_args(
124		#' labs = list(title = "TITLE"),
125		#' theme = list(title = ggplot2::element_text(size = 20))
126		#' ))
127		#' )
128		#'
129		#' parse_ggplot2_args(
130		#' resolve_ggplot2_args(
131		#' ggplot2_args(
132		#' labs = list(title = "TITLE"),
133		#' theme = list(title = ggplot2::element_text(size = 20))
134		#' )
135		#' ),
136		#' ggtheme = "gray"
137		#' )
138		parse_ggplot2_args <- function(ggplot2_args = teal.widgets::ggplot2_args(),
139		ggtheme = c(
140		"default",
141		"gray",
142		"bw",
143		"linedraw",
144		"light",
145		"dark",
146		"minimal",
147		"classic",
148		"void",
149		"test"
150		)) {
151	10x	checkmate::assert_class(ggplot2_args, "ggplot2_args")
152	9x	ggtheme <- match.arg(ggtheme)
153
154	9x	res_list <- list()
155
156	9x	labs_args <- ggplot2_args$labs
157
158	9x	labs_f <- if (length(labs_args)) {
159	5x	as.call(c(list(quote(ggplot2::labs)), labs_args))
160		} else {
161	4x	NULL
162		}
163
164	9x	default_theme <- if (ggtheme != "default") {
165	1x	as.call(list(str2lang(paste0("ggplot2::theme_", ggtheme))))
166		} else {
167	8x	NULL
168		}
169
170	9x	theme_args <- ggplot2_args$theme
171
172	9x	theme_f <- if (length(theme_args)) {
173	2x	as.call(c(list(quote(ggplot2::theme)), theme_args))
174		} else {
175	7x	NULL
176		}
177
178	9x	final_list <- Filter(Negate(is.null), list(labs = labs_f, ggtheme = default_theme, theme = theme_f))
179		# For empty final_list we want to return empty list, not empty named list
180	3x	`if`(length(final_list) == 0, list(), final_list)
181		}

1		#' Wrapper for `pickerInput`
2		#'
3		#' @description `r lifecycle::badge("stable")`
4		#' Wrapper for [shinyWidgets::pickerInput()] with additional features.
5		#' When `fixed = TRUE` or when the number of `choices` is less or equal to 1 (see `fixed_on_single`),
6		#' the `pickerInput` widget is hidden and non-interactive widget will be displayed
7		#' instead. Toggle of `HTML` elements is just the visual effect to avoid displaying
8		#' `pickerInput` widget when there is only one choice.
9		#'
10		#' @inheritParams shinyWidgets::pickerInput
11		#'
12		#' @param sep (`character(1)`)\cr
13		#' A separator string to split the `choices` or `selected` inputs into the values of the different
14		#' columns.
15		#'
16		#' @param label_help (`shiny.tag`) optional,\cr
17		#' e.g. an object returned by [shiny::helpText()].
18		#'
19		#' @param fixed (`logical(1)`) optional,\cr
20		#' whether to block user to select choices.
21		#'
22		#' @param fixed_on_single (`logical(1)`) optional,\cr
23		#' whether to block user to select a choice when there is only one or less choice.
24		#' When `FALSE`, user is still able to select or deselect the choice.
25		#'
26		#' @param width (`character(1)`)\cr
27		#' The width of the input passed to `pickerInput` e.g. `'auto'`, `'fit'`, `'100px'` or `'75%'`
28		#'
29		#' @return (`shiny.tag`) HTML tag with `pickerInput` widget and
30		#' non-interactive element listing selected values.
31		#'
32		#' @export
33		#'
34		#' @examples
35		#' library(shiny)
36		#'
37		#' # Create a minimal example data frame
38		#' data <- data.frame(
39		#' AGE = c(25, 30, 40, 35, 28),
40		#' SEX = c("Male", "Female", "Male", "Female", "Male"),
41		#' PARAMCD = c("Val1", "Val2", "Val3", "Val4", "Val5"),
42		#' PARAM = c("Param1", "Param2", "Param3", "Param4", "Param5"),
43		#' AVISIT = c("Visit1", "Visit2", "Visit3", "Visit4", "Visit5"),
44		#' stringsAsFactors = TRUE
45		#' )
46		#'
47		#' ui_grid <- function(...) {
48		#' bslib::page_fluid(
49		#' bslib::layout_columns(
50		#' col_widths = c(4, 4, 4),
51		#' ...
52		#' )
53		#' )
54		#' }
55		#'
56		#' ui <- ui_grid(
57		#' wellPanel(
58		#' optionalSelectInput(
59		#' inputId = "c1",
60		#' label = "Fixed choices",
61		#' choices = LETTERS[1:5],
62		#' selected = c("A", "B"),
63		#' fixed = TRUE
64		#' ),
65		#' verbatimTextOutput(outputId = "c1_out")
66		#' ),
67		#' wellPanel(
68		#' optionalSelectInput(
69		#' inputId = "c2",
70		#' label = "Single choice",
71		#' choices = "A",
72		#' selected = "A"
73		#' ),
74		#' verbatimTextOutput(outputId = "c2_out")
75		#' ),
76		#' wellPanel(
77		#' optionalSelectInput(
78		#' inputId = "c3",
79		#' label = "NULL choices",
80		#' choices = NULL
81		#' ),
82		#' verbatimTextOutput(outputId = "c3_out")
83		#' ),
84		#' wellPanel(
85		#' optionalSelectInput(
86		#' inputId = "c4",
87		#' label = "Default",
88		#' choices = LETTERS[1:5],
89		#' selected = "A"
90		#' ),
91		#' verbatimTextOutput(outputId = "c4_out")
92		#' ),
93		#' wellPanel(
94		#' optionalSelectInput(
95		#' inputId = "c5",
96		#' label = "Named vector",
97		#' choices = c(`A - value A` = "A", `B - value B` = "B", `C - value C` = "C"),
98		#' selected = "A"
99		#' ),
100		#' verbatimTextOutput(outputId = "c5_out")
101		#' ),
102		#' wellPanel(
103		#' selectInput(
104		#' inputId = "c6_choices", label = "Update choices", choices = letters, multiple = TRUE
105		#' ),
106		#' optionalSelectInput(
107		#' inputId = "c6",
108		#' label = "Updated choices",
109		#' choices = NULL,
110		#' multiple = TRUE,
111		#' fixed_on_single = TRUE
112		#' ),
113		#' verbatimTextOutput(outputId = "c6_out")
114		#' )
115		#' )
116		#'
117		#' server <- function(input, output, session) {
118		#' observeEvent(input$c6_choices, ignoreNULL = FALSE, {
119		#' updateOptionalSelectInput(
120		#' session = session,
121		#' inputId = "c6",
122		#' choices = input$c6_choices,
123		#' selected = input$c6_choices
124		#' )
125		#' })
126		#'
127		#' output$c1_out <- renderPrint(input$c1)
128		#' output$c2_out <- renderPrint(input$c2)
129		#' output$c3_out <- renderPrint(input$c3)
130		#' output$c4_out <- renderPrint(input$c4)
131		#' output$c5_out <- renderPrint(input$c5)
132		#' output$c6_out <- renderPrint(input$c6)
133		#' }
134		#'
135		#' if (interactive()) {
136		#' shinyApp(ui, server)
137		#' }
138		#'
139		optionalSelectInput <- function(inputId, # nolint
140		label = NULL,
141		choices = NULL,
142		selected = NULL,
143		multiple = FALSE,
144		sep = NULL,
145		options = list(),
146		label_help = NULL,
147		fixed = FALSE,
148		fixed_on_single = FALSE,
149		width = NULL) {
150	!	checkmate::assert_string(inputId)
151	!	checkmate::assert(
152	!	checkmate::check_string(label, null.ok = TRUE),
153	!	checkmate::check_class(label, "shiny.tag"),
154	!	checkmate::check_class(label, "shiny.tag.list"),
155	!	checkmate::check_class(label, "html")
156		)
157	!	stopifnot(is.null(choices) \|\| length(choices) >= 1)
158	!	stopifnot(
159	!	is.null(selected) \|\|
160	!	length(selected) == 0 \|\|
161	!	all(selected %in% choices) \|\|
162	!	all(selected %in% unlist(choices, recursive = FALSE))
163		)
164	!	checkmate::assert_flag(multiple)
165	!	checkmate::assert_string(sep, null.ok = TRUE)
166	!	checkmate::assert_list(options)
167	!	checkmate::assert(
168	!	checkmate::check_string(label_help, null.ok = TRUE),
169	!	checkmate::check_class(label_help, "shiny.tag"),
170	!	checkmate::check_class(label_help, "shiny.tag.list"),
171	!	checkmate::check_class(label_help, "html")
172		)
173	!	checkmate::assert_flag(fixed)
174	!	checkmate::assert_flag(fixed_on_single)
175
176	!	if (!is.null(width)) {
177	!	validateCssUnit(width)
178		}
179
180	!	default_options <- list(
181	!	"actions-box" = multiple,
182	!	"none-selected-text" = "- Nothing selected -",
183	!	"max-options" = ifelse(multiple, Inf, 1),
184	!	"show-subtext" = TRUE,
185	!	"live-search" = ifelse(length(choices) > 10, TRUE, FALSE)
186		)
187
188	!	options <- if (!identical(options, list())) {
189	!	c(options, default_options[setdiff(names(default_options), names(options))])
190		} else {
191	!	default_options
192		}
193
194	!	if (is.null(choices)) {
195	!	choices <- ""
196	!	selected <- NULL
197		}
198
199	!	if (length(choices) <= 1 && fixed_on_single) fixed <- TRUE
200
201	!	raw_choices <- extract_raw_choices(choices, attr(choices, "sep"))
202	!	raw_selected <- extract_raw_choices(selected, attr(choices, "sep"))
203
204		# Making sure the default dropdown popup can be displayed in the whole body, even outside the sidebars.
205	!	if (is.null(options$container)) {
206	!	options$container <- "body"
207		}
208
209	!	ui_picker <- tags$div(
210	!	id = paste0(inputId, "_input"),
211		# visibility feature marked with display: none/block instead of shinyjs::hide/show
212		# as mechanism to hide/show is handled by javascript code
213	!	style = if (fixed) "display: none;" else "display: block;",
214	!	shinyWidgets::pickerInput(
215	!	inputId = inputId,
216	!	label = label,
217	!	choices = raw_choices,
218	!	selected = raw_selected,
219	!	multiple = TRUE,
220	!	width = width,
221	!	options = options,
222	!	choicesOpt = picker_options(choices)
223		)
224		)
225
226	!	if (!is.null(label_help)) {
227	!	ui_picker[[3]] <- append(ui_picker[[3]], list(tags$div(class = "label-help", label_help)), after = 1)
228		}
229
230	!	ui_fixed <- tags$div(
231	!	id = paste0(inputId, "_fixed"),
232		# visibility feature marked with display: none/block instead of shinyjs::hide/show
233		# as mechanism to hide/show is handled by javascript code
234	!	style = if (fixed) "display: block;" else "display: none;",
235	!	tags$label(class = "control-label", label),
236		# selected values as verbatim text
237	!	tags$code(
238	!	id = paste0(inputId, "_selected_text"),
239	!	if (length(selected) > 0) {
240	!	toString(selected)
241		} else {
242	!	"NULL"
243		}
244		),
245	!	label_help
246		)
247
248	!	tags$div(
249		# when selected values in ui_picker change
250		# then update ui_fixed - specifically, update '{id}_selected_text' element
251	!	tags$script(
252	!	sprintf(
253		"
254	!	$(function() {
255	!	$('#%1$s').on('change', function(e) {
256	!	var select_concat = $(this).val().length ? $(this).val().join(', ') : 'NULL';
257	!	$('#%1$s_selected_text').html(select_concat);
258		})
259		})",
260	!	inputId
261		)
262		),
263
264		# if ui_picker has only one or less option or is fixed then hide {id}_input and show {id}_fixed
265	!	if (fixed_on_single) {
266	!	js <- sprintf(
267	!	"$(function() {
268	!	$('#%1$s').on('change', function(e) {
269	!	var options = $('#%1$s').find('option');
270	!	if (options.length == 1) {
271	!	$('#%1$s_input').hide();
272	!	$('#%1$s_fixed').show();
273		} else {
274	!	$('#%1$s_input').show();
275	!	$('#%1$s_fixed').hide();
276		}
277		})
278		})",
279	!	inputId
280		)
281	!	tags$script(js)
282		},
283	!	tags$div(ui_picker, ui_fixed)
284		)
285		}
286
287		#' @rdname optionalSelectInput
288		#' @param session (`shiny.session`)\cr
289		#' @export
290		updateOptionalSelectInput <- function(session, # nolint
291		inputId, # nolint
292		label = NULL,
293		selected = NULL,
294		choices = NULL) {
295	!	raw_choices <- extract_raw_choices(choices, attr(choices, "sep"))
296	!	raw_selected <- extract_raw_choices(selected, attr(choices, "sep"))
297
298		# update picker input
299	!	shinyWidgets::updatePickerInput(
300	!	session = session,
301	!	inputId = inputId,
302	!	label = label,
303	!	selected = as.character(raw_selected),
304	!	choices = raw_choices,
305	!	choicesOpt = picker_options(choices)
306		)
307
308	!	invisible(NULL)
309		}
310
311		#' Get icons to represent variable types in dataset
312		#'
313		#' @param var_type (`character`)\cr
314		#' of R internal types (classes).
315		#'
316		#' @return (`character`)\cr
317		#' vector of HTML icons corresponding to data type in each column.
318		#' @keywords internal
319		#'
320		variable_type_icons <- function(var_type) {
321	!	checkmate::assert_character(var_type, any.missing = FALSE)
322
323	!	class_to_icon <- list(
324	!	numeric = "arrow-up-1-9",
325	!	integer = "arrow-up-1-9",
326	!	logical = "pause",
327	!	Date = "calendar",
328	!	POSIXct = "calendar",
329	!	POSIXlt = "calendar",
330	!	factor = "chart-bar",
331	!	character = "keyboard",
332	!	primary_key = "key",
333	!	unknown = "circle-question"
334		)
335	!	class_to_icon <- lapply(class_to_icon, function(icon_name) toString(icon(icon_name, lib = "font-awesome")))
336
337	!	res <- unname(vapply(
338	!	var_type,
339	!	FUN.VALUE = character(1),
340	!	FUN = function(class) {
341	!	if (class == "") {
342	!	class
343	!	} else if (is.null(class_to_icon[[class]])) {
344	!	class_to_icon[["unknown"]]
345		} else {
346	!	class_to_icon[[class]]
347		}
348		}
349		))
350
351	!	res
352		}
353
354		#' Optional content for `optionalSelectInput`
355		#'
356		#' Prepares content to be displayed in `optionalSelectInput` with icons and labels
357		#'
358		#' @param var_name (`character`)\cr
359		#' variable name
360		#' @param var_label (`character`)\cr
361		#' variable alternative name - for example variable label
362		#' @param var_type (`character`)
363		#' class of the variable.
364		#'
365		#' @return (`character`) HTML contents with all elements combined
366		#' @keywords internal
367		#'
368		picker_options_content <- function(var_name, var_label, var_type) {
369	!	if (length(var_name) == 0) {
370	!	res <- character(0)
371	!	} else if (length(var_type) == 0 && length(var_label) == 0) {
372	!	res <- var_name
373		} else {
374	!	checkmate::assert_character(var_name, min.len = 1, any.missing = FALSE)
375	!	stopifnot(
376	!	identical(var_type, character(0)) \|\| length(var_type) == length(var_name),
377	!	identical(var_label, character(0)) \|\| length(var_label) == length(var_name)
378		)
379
380	!	var_icon <- variable_type_icons(var_type)
381
382	!	res <- trimws(paste(
383	!	var_icon,
384	!	var_name,
385	!	vapply(
386	!	var_label,
387	!	function(x) {
388	!	ifelse(x == "", "", toString(tags$small(x, class = "text-muted")))
389		},
390	!	character(1)
391		)
392		))
393		}
394
395	!	res
396		}
397
398		#' Create `choicesOpt` for `pickerInput`
399		#'
400		#' @param choices (`choices_labeled` or `character`)\cr
401		#' choices vector
402		#'
403		#' @return (`list`)\cr
404		#' to be passed as `choicesOpt` argument.
405		#' @keywords internal
406		picker_options <- function(choices) {
407	!	if (inherits(choices, "choices_labeled")) {
408	!	raw_choices <- extract_raw_choices(choices, sep = attr(choices, "sep"))
409	!	res <- list(
410	!	content = picker_options_content(
411	!	var_name = raw_choices,
412	!	var_label = extract_choices_labels(choices),
413	!	var_type = if (is.null(attr(choices, "types"))) character(0) else attr(choices, "types")
414		)
415		)
416	!	} else if (all(vapply(choices, inherits, logical(1), "choices_labeled"))) {
417	!	choices <- unlist(unname(choices))
418	!	res <- list(content = picker_options_content(
419	!	var_name = choices,
420	!	var_label = extract_choices_labels(choices),
421	!	var_type = if (is.null(attr(choices, "types"))) character(0) else attr(choices, "types")
422		))
423		} else {
424	!	res <- NULL
425		}
426	!	res
427		}
428
429		#' Extract raw values from choices
430		#'
431		#' @param choices (`choices_labeled`, `list` or `character`)\cr
432		#' object containing choices
433		#' @param sep (`character(1)`)\cr
434		#' A separator string to split the `choices` or `selected` inputs into the values of
435		#' the different columns.
436		#' @return choices simplified
437		#' @keywords internal
438		extract_raw_choices <- function(choices, sep) {
439	!	if (!is.null(sep)) {
440	!	vapply(choices, paste, collapse = sep, character(1))
441	!	} else if (inherits(choices, "choices_labeled")) {
442	!	unname(unlist(choices))
443		} else {
444	!	choices
445		}
446		}
447
448		#' if min or max are `NA` then the slider widget will be hidden
449		#'
450		#' @description `r lifecycle::badge("stable")`\cr
451		#' Hidden input widgets are useful to have the `input[[inputId]]` variable
452		#' on available in the server function but no corresponding visual clutter from
453		#' input widgets that provide only a single choice.
454		#'
455		#' @inheritParams shiny::sliderInput
456		#' @param label_help (`shiny.tag`) optional\cr
457		#' object of class `shiny.tag`, e.g. an object returned by [shiny::helpText()]
458		#' @param ... optional arguments to `sliderInput`
459		#'
460		#' @return (`shiny.tag`) HTML tag with `sliderInput` widget.
461		#'
462		#' @export
463		#'
464		#' @examples
465		#' ui <- bslib::page_fluid(
466		#' shinyjs::useShinyjs(),
467		#' optionalSliderInput("s", "shown", 0, 1, 0.2),
468		#' optionalSliderInput("h", "hidden", 0, NA, 1),
469		#' )
470		#' if (interactive()) {
471		#' shiny::shinyApp(ui, function(input, output) {})
472		#' }
473		optionalSliderInput <- function(inputId, label, min, max, value, label_help = NULL, ...) { # nolint
474	21x	checkmate::assert_number(min, na.ok = TRUE)
475	21x	checkmate::assert_number(max, na.ok = TRUE)
476	21x	checkmate::assert_numeric(value, min.len = 1, max.len = 2, any.missing = FALSE)
477
478	21x	is_na_min <- is.na(min)
479	21x	is_na_max <- is.na(max)
480
481	21x	hide <- is_na_min \|\| is_na_max
482
483	21x	if (length(value) == 2) {
484	2x	value1 <- value[1]
485	2x	value2 <- value[2]
486		} else {
487	19x	value1 <- value
488	19x	value2 <- value
489		}
490
491	21x	if (is_na_min) {
492	2x	min <- value1 - 1
493		}
494	21x	if (is_na_max) {
495	1x	max <- value2 + 1
496		}
497
498	21x	if (min > value1 \|\| max < value2) {
499	2x	stop("arguments inconsistent: min <= value <= max expected")
500		}
501
502	19x	slider <- sliderInput(inputId, label, min, max, value, ...)
503
504	19x	if (!is.null(label_help)) {
505	!	slider[[3]] <- append(slider[[3]], list(tags$div(class = "label-help", label_help)), after = 1)
506		}
507
508	19x	if (hide) {
509	2x	shinyjs::hidden(slider)
510		} else {
511	17x	slider
512		}
513		}
514
515		#' For `teal` modules we parameterize an `optionalSliderInput` with one argument
516		#' `value_min_max`
517		#'
518		#' @description `r lifecycle::badge("stable")`
519		#' The [optionalSliderInput()] function needs three arguments to determine
520		#' whether to hide the `sliderInput` widget or not. For `teal` modules we specify an
521		#' optional slider input with one argument here called `value_min_max`.
522		#'
523		#' @inheritParams optionalSliderInput
524		#'
525		#' @param value_min_max (`numeric(1)` or `numeric(3)`)\cr
526		#' If of length 1 then the value gets set to that number and the `sliderInput` will be hidden.
527		#' Otherwise, if it is of length three the three elements will map to `value`, `min` and `max` of
528		#' the [optionalSliderInput()] function.
529		#'
530		#' @return (`shiny.tag`) HTML tag with range `sliderInput` widget.
531		#'
532		#' @export
533		#'
534		#' @examples
535		#'
536		#' ui <- bslib::page_fluid(
537		#' shinyjs::useShinyjs(),
538		#' optionalSliderInputValMinMax("a1", "b1", 1),
539		#' optionalSliderInputValMinMax("a2", "b2", c(3, 1, 5))
540		#' )
541		#' if (interactive()) {
542		#' shiny::shinyApp(ui, function(input, output) {})
543		#' }
544		optionalSliderInputValMinMax <- function(inputId, label, value_min_max, label_help = NULL, ...) { # nolint
545	14x	checkmate::assert(
546	14x	checkmate::check_numeric(
547	14x	value_min_max,
548	14x	finite = TRUE,
549	14x	len = 3
550		),
551	14x	checkmate::check_numeric(
552	14x	value_min_max,
553	14x	finite = TRUE,
554	14x	len = 1
555		)
556		)
557
558	14x	x <- value_min_max
559
560	14x	vals <- if (length(x) == 3) {
561	14x	checkmate::assert_number(x[1], lower = x[2], upper = x[3], .var.name = "value_min_max")
562	14x	list(value = x[1], min = x[2], max = x[3])
563	14x	} else if (length(x) == 1) {
564	!	list(value = x, min = NA_real_, max = NA_real_)
565		}
566
567	14x	slider <- optionalSliderInput(inputId, label, vals$min, vals$max, vals$value, ...)
568
569	14x	if (!is.null(label_help)) {
570	!	slider[[3]] <- append(slider[[3]], list(tags$div(class = "label-help", label_help)), after = 1)
571		}
572	14x	slider
573		}
574
575		#' Extract labels from choices basing on attributes and names
576		#'
577		#' @param choices (`list` or `vector`)\cr
578		#' select choices
579		#' @param values optional\cr
580		#' choices subset for which labels should be extracted, `NULL` for all choices.
581		#'
582		#' @return (`character`) vector with labels
583		#' @keywords internal
584		extract_choices_labels <- function(choices, values = NULL) {
585	!	res <- if (inherits(choices, "choices_labeled")) {
586	!	attr(choices, "raw_labels")
587	!	} else if (!is.null(names(choices)) && !setequal(names(choices), unlist(unname(choices)))) {
588	!	names(choices)
589		} else {
590	!	NULL
591		}
592
593	!	if (!is.null(values) && !is.null(res)) {
594	!	stopifnot(all(values %in% choices))
595	!	res <- res[vapply(values, function(val) which(val == choices), numeric(1))]
596		}
597
598	!	res
599		}

1		#' @keywords internal
2		#' @noRd
3		plot_with_settings_deps <- function() {
4	1x	htmltools::htmlDependency(
5	1x	name = "teal-widgets-plot-with-settings",
6	1x	version = utils::packageVersion("teal.widgets"),
7	1x	package = "teal.widgets",
8	1x	src = "plot-with-settings",
9	1x	stylesheet = "plot-with-settings.css",
10	1x	script = "plot-with-settings.js"
11		)
12		}
13
14		#' @name plot_with_settings
15		#' @rdname plot_with_settings
16		#' @export
17		plot_with_settings_ui <- function(id) {
18	1x	checkmate::assert_string(id)
19
20	1x	ns <- NS(id)
21
22	1x	tags$div(
23	1x	plot_with_settings_deps(),
24	1x	shinyjs::useShinyjs(),
25	1x	bslib::card(
26	1x	id = ns("plot-with-settings"),
27	1x	full_screen = TRUE,
28	1x	tags$div(
29	1x	tags$div(
30	1x	class = "teal-widgets settings-buttons",
31	1x	bslib::tooltip(
32	1x	trigger = tags$div(
33	1x	bslib::popover(
34	1x	id = ns("expbut"),
35	1x	trigger = icon("maximize"),
36	1x	uiOutput(ns("slider_ui")),
37	1x	uiOutput(ns("width_warning"))
38		)
39		),
40	1x	options = list(trigger = "hover"),
41	1x	class = "resize-button",
42	1x	"Resize"
43		),
44	1x	bslib::tooltip(
45	1x	trigger = tags$div(type_download_ui(ns("downbutton"))),
46	1x	options = list(trigger = "hover"),
47	1x	class = "download-button",
48	1x	"Download"
49		)
50		),
51	1x	tags$div(
52	1x	id = ns("plot-out-main"),
53	1x	class = "teal-widgets plot-content",
54	1x	uiOutput(ns("plot_out_main"))
55		)
56		)
57		)
58		)
59		}
60
61		#' Plot-with-settings module
62		#'
63		#' @rdname plot_with_settings
64		#' @description `r lifecycle::badge("stable")`\cr
65		#' Universal module for plots with settings for height, width, and download.
66		#'
67		#' @export
68		#'
69		#' @param id (`character(1)`) `shiny` module id.
70		#'
71		#' @param plot_r (`reactive` or `function`)\cr
72		#' `reactive` expression or a simple `function` to draw a plot.
73		#' A simple `function` is needed e.g. for base plots like `plot(1)` as the output can not be caught when downloading.
74		#' Take into account that simple functions are less efficient than reactive, as not catching the result.
75		#' @param height (`numeric`) optional\cr
76		#' vector with three elements c(VAL, MIN, MAX), where VAL is the starting value of the slider in
77		#' the main and expanded plot display.
78		#' @param width (`numeric`) optional\cr
79		#' vector with three elements `c(VAL, MIN, MAX)`, where VAL is the starting value of the slider in
80		#' the main and expanded plot display; `NULL` for default display.
81		#' @param show_hide_signal optional, (`reactive logical` a mechanism to allow modules which call this
82		#' module to show/hide the plot_with_settings UI)
83		#' @param brushing (`logical`) optional\cr
84		#' mechanism to enable / disable brushing on the main plot.
85		#' All the brushing data is stored as a reactive object in the `"brush"` element of
86		#' returned list. See the example for details.
87		#' @param clicking (`logical`)\cr
88		#' a mechanism to enable / disable clicking on data points on the main plot.
89		#' All the clicking data is stored as a reactive object in the `"click"`
90		#' element of returned list. See the example for details.
91		#' @param dblclicking (`logical`) optional\cr
92		#' mechanism to enable / disable double-clicking on data points on the main plot.
93		#' All the double clicking data is stored as a reactive object in the
94		#' the `"dblclick"` element of returned list. See the example for details.
95		#' @param hovering (`logical(1)`) optional\cr
96		#' mechanism to enable / disable hovering over data points on the main plot.
97		#' All the hovering data is stored as a reactive object in the
98		#' `"hover"` element of returned list. See the example for details.
99		#' @param graph_align (`character(1)`) optional,\cr
100		#' one of `"left"` (default), `"center"`, `"right"` or `"justify"`. The alignment of the graph on
101		#' the main page.
102		#'
103		#' @details By default the plot is rendered with `72 dpi`. In order to change this, to for example 96 set
104		#' `options(teal.plot_dpi = 96)`. The minimum allowed `dpi` value is `24` and it must be a whole number.
105		#' If an invalid value is set then the default value is used and a warning is outputted to the console.
106		#'
107		#' @return A `shiny` module.
108		#'
109		#' @examples
110		#' # Example using a reactive as input to plot_r
111		#' library(shiny)
112		#' library(ggplot2)
113		#'
114		#' ui <- bslib::page_fluid(
115		#' plot_with_settings_ui(
116		#' id = "plot_with_settings"
117		#' )
118		#' )
119		#'
120		#' server <- function(input, output, session) {
121		#' plot_r <- reactive({
122		#' ggplot(faithful, aes(x = .data$waiting, y = .data$eruptions)) +
123		#' geom_point()
124		#' })
125		#'
126		#' plot_with_settings_srv(
127		#' id = "plot_with_settings",
128		#' plot_r = plot_r,
129		#' height = c(400, 100, 1200),
130		#' width = c(500, 250, 750)
131		#' )
132		#' }
133		#'
134		#' if (interactive()) {
135		#' shinyApp(ui, server)
136		#' }
137		#'
138		#' # Example using a function as input to plot_r
139		#' library(lattice)
140		#'
141		#' ui <- bslib::page_fluid(
142		#' radioButtons("download_option", "Select the Option", list("ggplot", "trellis", "grob", "base")),
143		#' plot_with_settings_ui(
144		#' id = "plot_with_settings"
145		#' ),
146		#' sliderInput("nums", "Value", 1, 10, 1)
147		#' )
148		#'
149		#' server <- function(input, output, session) {
150		#' plot_r <- function() {
151		#' numbers <- seq_len(input$nums)
152		#' if (input$download_option == "ggplot") {
153		#' ggplot(data.frame(n = numbers), aes(.data$n)) +
154		#' geom_bar()
155		#' } else if (input$download_option == "trellis") {
156		#' densityplot(numbers)
157		#' } else if (input$download_option == "grob") {
158		#' tr_plot <- densityplot(numbers)
159		#' ggplotGrob(
160		#' ggplot(data.frame(n = numbers), aes(.data$n)) +
161		#' geom_bar()
162		#' )
163		#' } else if (input$download_option == "base") {
164		#' plot(numbers)
165		#' }
166		#' }
167		#'
168		#' plot_with_settings_srv(
169		#' id = "plot_with_settings",
170		#' plot_r = plot_r,
171		#' height = c(400, 100, 1200),
172		#' width = c(500, 250, 750)
173		#' )
174		#' }
175		#'
176		#' if (interactive()) {
177		#' shinyApp(ui, server)
178		#' }
179		#'
180		#' # Example with brushing/hovering/clicking/double-clicking
181		#' ui <- bslib::page_fluid(
182		#' plot_with_settings_ui(
183		#' id = "plot_with_settings"
184		#' ),
185		#' fluidRow(
186		#' column(4, tags$h3("Brush"), verbatimTextOutput("brushing_data")),
187		#' column(4, tags$h3("Click"), verbatimTextOutput("clicking_data")),
188		#' column(4, tags$h3("DblClick"), verbatimTextOutput("dblclicking_data")),
189		#' column(4, tags$h3("Hover"), verbatimTextOutput("hovering_data"))
190		#' )
191		#' )
192		#'
193		#' server <- function(input, output, session) {
194		#' plot_r <- reactive({
195		#' ggplot(faithful, aes(x = .data$waiting, y = .data$eruptions)) +
196		#' geom_point()
197		#' })
198		#'
199		#' plot_data <- plot_with_settings_srv(
200		#' id = "plot_with_settings",
201		#' plot_r = plot_r,
202		#' height = c(400, 100, 1200),
203		#' brushing = TRUE,
204		#' clicking = TRUE,
205		#' dblclicking = TRUE,
206		#' hovering = TRUE
207		#' )
208		#'
209		#' output$brushing_data <- renderPrint(plot_data$brush())
210		#' output$clicking_data <- renderPrint(plot_data$click())
211		#' output$dblclicking_data <- renderPrint(plot_data$dblclick())
212		#' output$hovering_data <- renderPrint(plot_data$hover())
213		#' }
214		#'
215		#' if (interactive()) {
216		#' shinyApp(ui, server)
217		#' }
218		#'
219		#' # Example which allows module to be hidden/shown
220		#' library("shinyjs")
221		#'
222		#' ui <- bslib::page_fluid(
223		#' useShinyjs(),
224		#' actionButton("button", "Show/Hide"),
225		#' plot_with_settings_ui(
226		#' id = "plot_with_settings"
227		#' )
228		#' )
229		#'
230		#' server <- function(input, output, session) {
231		#' plot_r <- plot_r <- reactive(
232		#' ggplot(faithful, aes(x = .data$waiting, y = .data$eruptions)) +
233		#' geom_point()
234		#' )
235		#'
236		#' show_hide_signal_rv <- reactiveVal(TRUE)
237		#'
238		#' observeEvent(input$button, show_hide_signal_rv(!show_hide_signal_rv()))
239		#'
240		#' plot_with_settings_srv(
241		#' id = "plot_with_settings",
242		#' plot_r = plot_r,
243		#' height = c(400, 100, 1200),
244		#' width = c(500, 250, 750),
245		#' show_hide_signal = reactive(show_hide_signal_rv())
246		#' )
247		#' }
248		#'
249		#' if (interactive()) {
250		#' shinyApp(ui, server)
251		#' }
252		#'
253		plot_with_settings_srv <- function(id,
254		plot_r,
255		height = c(600, 200, 2000),
256		width = NULL,
257		show_hide_signal = reactive(TRUE),
258		brushing = FALSE,
259		clicking = FALSE,
260		dblclicking = FALSE,
261		hovering = FALSE,
262		graph_align = "left") {
263	22x	checkmate::assert_string(id)
264	22x	checkmate::assert(
265	22x	checkmate::check_class(plot_r, "function"),
266	22x	checkmate::check_class(plot_r, "reactive")
267		)
268	21x	checkmate::assert_numeric(height, min.len = 1, any.missing = FALSE)
269	20x	checkmate::assert_numeric(height, len = 3, any.missing = FALSE, finite = TRUE)
270	20x	checkmate::assert_numeric(height[1], lower = height[2], upper = height[3], .var.name = "height")
271	20x	checkmate::assert_numeric(width, len = 3, any.missing = FALSE, null.ok = TRUE, finite = TRUE)
272	20x	checkmate::assert_numeric(width[1], lower = width[2], upper = width[3], null.ok = TRUE, .var.name = "width")
273
274	19x	checkmate::assert_class(show_hide_signal, c("reactive", "function"))
275	18x	checkmate::assert_flag(brushing)
276	17x	checkmate::assert_flag(clicking)
277	16x	checkmate::assert_flag(dblclicking)
278	15x	checkmate::assert_flag(hovering)
279	14x	checkmate::assert_string(graph_align)
280	14x	checkmate::assert_subset(graph_align, c("left", "right", "center", "justify"))
281
282	13x	moduleServer(id, function(input, output, session) {
283	13x	ns <- session$ns
284	13x	shinyjs::runjs(
285	13x	sprintf(
286	13x	'establishPlotResizing("%s", "%s");',
287	13x	ns("plot-out-main"), # graph parent id
288	13x	ns("flex_width") # session input$ variable name
289		)
290		)
291	13x	default_w <- function() session$clientData[[paste0("output_", ns("plot_main_width"))]]
292	13x	default_h <- function() session$clientData[[paste0("output_", ns("plot_main_height"))]]
293
294	13x	default_slider_width <- reactiveVal(width)
295	13x	delayed_flex_width <- debounce(reactive(input$flex_width), millis = 100)
296
297	13x	if (is.null(width)) {
298		# if width = NULL then set default_slider_width to be the value of the plot width on load
299	!	observeEvent(session$clientData[[paste0("output_", ns("plot_main_width"))]],
300	!	handlerExpr = {
301	!	default_slider_width(default_w() * c(1, 0.5, 2.8))
302		},
303	!	once = TRUE,
304	!	ignoreNULL = TRUE
305		)
306
307	!	observeEvent(delayed_flex_width(), {
308	!	if (delayed_flex_width() > 0 && !isFALSE(input$width_resize_switch)) {
309	!	default_slider_width(delayed_flex_width() * c(1, 0.5, 2.8))
310	!	updateSliderInput(session, inputId = "width", value = delayed_flex_width())
311		}
312		})
313		}
314
315	13x	plot_type <- reactive({
316	13x	if (inherits(plot_r(), "ggplot")) {
317	2x	"gg"
318	11x	} else if (inherits(plot_r(), "trellis")) {
319	2x	"trel"
320	9x	} else if (inherits(plot_r(), "grob")) {
321	2x	"grob"
322	7x	} else if (inherits(plot_r(), c("NULL", "histogram", "list")) && !inherits(plot_r, "reactive")) {
323	5x	"base"
324		} else {
325	2x	"other"
326		}
327		})
328
329		# allow modules which use this module to turn on and off the UI
330	13x	observeEvent(show_hide_signal(), {
331	7x	if (show_hide_signal()) {
332	7x	shinyjs::show("plot-with-settings")
333		} else {
334	!	shinyjs::hide("plot-with-settings")
335		}
336		})
337
338	13x	output$slider_ui <- renderUI({
339	7x	req(default_slider_width())
340	7x	tags$div(
341	7x	optionalSliderInputValMinMax(
342	7x	inputId = ns("height"),
343	7x	label = "Plot height",
344	7x	value_min_max = round(height),
345	7x	ticks = FALSE,
346	7x	step = 1L,
347	7x	round = TRUE
348		),
349	7x	tags$b("Plot width"),
350	7x	shinyWidgets::switchInput(
351	7x	inputId = ns("width_resize_switch"),
352	7x	onLabel = "ON",
353	7x	offLabel = "OFF",
354	7x	label = "Auto width",
355	7x	value = `if`(is.null(width), TRUE, FALSE),
356	7x	size = "mini",
357	7x	labelWidth = "80px"
358		),
359	7x	optionalSliderInputValMinMax(
360	7x	inputId = ns("width"),
361	7x	label = NULL,
362	7x	value_min_max = round(isolate(default_slider_width())),
363	7x	ticks = FALSE,
364	7x	step = 1L,
365	7x	round = TRUE
366		)
367		)
368		})
369
370	13x	observeEvent(input$width_resize_switch \| delayed_flex_width(), {
371	7x	if (length(input$width_resize_switch) && input$width_resize_switch) {
372	!	shinyjs::disable("width")
373	!	updateSliderInput(session, inputId = "width", value = delayed_flex_width())
374		} else {
375	7x	shinyjs::enable("width")
376		}
377		})
378
379	13x	ranges <- reactiveValues(x = NULL, y = NULL)
380
381	13x	observeEvent(input$plot_dblclick, {
382	1x	brush <- input$plot_brush
383	1x	if (!is.null(brush)) {
384	!	ranges$x <- c(brush$xmin, brush$xmax)
385	!	ranges$y <- c(brush$ymin, brush$ymax)
386		} else {
387	1x	ranges$x <- NULL
388	1x	ranges$y <- NULL
389		}
390		})
391
392	13x	p_height <- reactive(if (!is.null(input$height)) input$height else height[1])
393	13x	p_width <- reactive(
394	13x	if (!is.null(input$width)) {
395	5x	input$width
396		} else {
397	2x	if (!is.null(default_slider_width()[1])) {
398	2x	default_slider_width()[1]
399		} else {
400		# Fallback to "auto"
401	!	"auto"
402		}
403		}
404		)
405	13x	output$plot_main <- renderPlot(
406	13x	apply_plot_modifications(
407	13x	plot_obj = plot_suppress(plot_r()),
408	13x	plot_type = plot_suppress(plot_type()),
409	13x	dblclicking = dblclicking,
410	13x	ranges = ranges
411		),
412	13x	res = get_plot_dpi(),
413	13x	height = p_height,
414	13x	width = p_width
415		)
416
417	13x	output$plot_out_main <- renderUI({
418	7x	req(plot_suppress(plot_r()))
419	4x	tags$div(
420	4x	align = graph_align,
421	4x	plotOutput(
422	4x	ns("plot_main"),
423	4x	height = "100%",
424	4x	width = p_width(),
425	4x	brush = `if`(brushing, brushOpts(ns("plot_brush"), resetOnNew = FALSE), NULL),
426	4x	click = `if`(clicking, clickOpts(ns("plot_click")), NULL),
427	4x	dblclick = `if`(dblclicking, dblclickOpts(ns("plot_dblclick")), NULL),
428	4x	hover = `if`(hovering, hoverOpts(ns("plot_hover")), NULL)
429		)
430		)
431		})
432
433	13x	output$width_warning <- renderUI({
434	7x	grDevices::pdf(nullfile()) # reset Rplots.pdf for shiny server
435	7x	w <- grDevices::dev.size("px")[1]
436	7x	grDevices::dev.off()
437	7x	if (p_width() < w) {
438	7x	helpText(
439	7x	icon("triangle-exclamation"),
440	7x	"Plot might be cut off for small widths."
441		)
442		}
443		})
444
445	13x	type_download_srv(
446	13x	id = "downbutton",
447	13x	plot_reactive = plot_r,
448	13x	plot_type = plot_type,
449	13x	plot_w = p_width,
450	13x	default_w = default_w,
451	13x	plot_h = p_height,
452	13x	default_h = default_h
453		)
454
455	13x	list(
456	13x	brush = reactive({
457		# refresh brush data on the main plot size change
458	1x	input$height
459	1x	input$width
460	1x	input$plot_brush
461		}),
462	13x	click = reactive({
463		# refresh click data on the main plot size change
464	1x	input$height
465	1x	input$width
466	1x	input$plot_click
467		}),
468	13x	dblclick = reactive({
469		# refresh double click data on the main plot size change
470	1x	input$height
471	1x	input$width
472	1x	input$plot_dblclick
473		}),
474	13x	hover = reactive({
475		# refresh hover data on the main plot size change
476	1x	input$height
477	1x	input$width
478	1x	input$plot_hover
479		}),
480	13x	dim = reactive(c(p_width(), p_height()))
481		)
482		})
483		}
484
485		#' @keywords internal
486		type_download_ui <- function(id) {
487	2x	ns <- NS(id)
488	2x	bslib::popover(
489	2x	icon("download"),
490	2x	tags$div(
491	2x	radioButtons(ns("file_format"),
492	2x	label = "File type",
493	2x	choices = c("png" = "png", "pdf" = "pdf", "svg" = "svg"),
494		),
495	2x	textInput(ns("file_name"),
496	2x	label = "File name (without extension)",
497	2x	value = paste0("plot_", strftime(Sys.time(), format = "%Y%m%d_%H%M%S"))
498		),
499	2x	conditionalPanel(
500	2x	condition = paste0("input['", ns("file_name"), "'] != ''"),
501	2x	downloadButton(ns("data_download"), label = character(0), class = "btn-sm w-full")
502		)
503		)
504		)
505		}
506
507		#' @keywords internal
508		type_download_srv <- function(id, plot_reactive, plot_type, plot_w, default_w, plot_h, default_h) {
509	17x	moduleServer(
510	17x	id,
511	17x	function(input, output, session) {
512	17x	output$data_download <- downloadHandler(
513	17x	filename = function() {
514	19x	paste(input$file_name, input$file_format, sep = ".")
515		},
516	17x	content = function(file) {
517	19x	width <- `if`(!is.null(plot_w()), plot_w(), default_w())
518	19x	height <- `if`(!is.null(plot_h()), plot_h(), default_h())
519
520		# svg and pdf have width in inches and 1 inch = get_plot_dpi() pixels
521	19x	switch(input$file_format,
522	11x	png = grDevices::png(file, width, height),
523	4x	pdf = grDevices::pdf(file, width / get_plot_dpi(), height / get_plot_dpi()),
524	4x	svg = grDevices::svg(file, width / get_plot_dpi(), height / get_plot_dpi())
525		)
526
527	19x	print_plot(plot_reactive, plot_type)
528
529	19x	grDevices::dev.off()
530		}
531		)
532		}
533		)
534		}
535
536		#' Clean brushed points
537		#'
538		#' @description `r lifecycle::badge("stable")`\cr
539		#' Cleans and organizes output to account for NAs and remove empty rows. Wrapper around `shiny::brushedPoints`.
540		#' @param data (`data.frame`)\cr
541		#' A data.frame from which to select rows.
542		#' @param brush (`list`)\cr
543		#' The data from a brush e.g. `input$plot_brush`.
544		#'
545		#' @return A `data.frame` of selected rows.
546		#'
547		#' @examples
548		#'
549		#' brush <- list(
550		#' mapping = list(
551		#' x = "AGE",
552		#' y = "BMRKR1"
553		#' ),
554		#' xmin = 30, xmax = 40,
555		#' ymin = 0.7, ymax = 10,
556		#' direction = "xy"
557		#' )
558		#'
559		#' data <- data.frame(
560		#' STUDYID = letters[1:20],
561		#' USUBJID = LETTERS[1:20],
562		#' AGE = sample(25:40, size = 20, replace = TRUE),
563		#' BMRKR1 = runif(20, min = 0, max = 12)
564		#' )
565		#' nrow(clean_brushedPoints(data, brush))
566		#' data$AGE[1:10] <- NA
567		#' nrow(clean_brushedPoints(data, brush))
568		#'
569		#' @export
570		#'
571		clean_brushedPoints <- function(data, brush) { # nolint object_name_linter.
572	6x	checkmate::assert_data_frame(data)
573	4x	checkmate::assert_list(brush, null.ok = TRUE)
574
575		# define original panelvar1 and panelvar2 before getting overwritten
576	4x	original_panelvar1 <- brush$mapping$panelvar1
577	4x	original_panelvar2 <- brush$mapping$panelvar2
578
579		# Assign NULL to `mapping$panelvar1` and `mapping$panelvar1` if `brush$panelvar1` and `brush$panelvar1` are NULL
580		# This will not evaluate the `panelMatch` step in `brushedPoints` and thus will return a non empty dataframe
581	4x	if (is.null(brush$panelvar1)) brush$mapping$panelvar1 <- NULL
582	4x	if (is.null(brush$panelvar2)) brush$mapping$panelvar2 <- NULL
583
584	4x	bp_df <- brushedPoints(data, brush)
585
586		# Keep required rows only based on the value of `brush$panelvar1`
587	3x	df <- if (is.null(brush$panelvar1) && is.character(original_panelvar1) &&
588	3x	is.null(brush$panelvar2) && is.character(original_panelvar2)) {
589	!	df_var1 <- bp_df[is.na(bp_df[[original_panelvar1]]), ]
590	!	df_var1[is.na(df_var1[[original_panelvar2]]), ]
591	3x	} else if (is.null(brush$panelvar1) && is.character(original_panelvar1)) {
592	!	bp_df[is.na(bp_df[[original_panelvar1]]), ]
593	3x	} else if (is.null(brush$panelvar2) && is.character(original_panelvar2)) {
594	!	bp_df[is.na(bp_df[[original_panelvar2]]), ]
595		} else {
596	3x	bp_df
597		}
598
599		# filter out rows that are only NAs
600	3x	df <- df[rowSums(is.na(df)) != ncol(df), ]
601	3x	df
602		}
603
604		#' @keywords internal
605		#'
606		get_plot_dpi <- function() {
607	38x	default_dpi <- 72
608	38x	dpi <- getOption("teal.plot_dpi", default_dpi)
609	38x	if (!checkmate::test_integerish(dpi, lower = 24, any.missing = FALSE, len = 1)) {
610	4x	warning(paste("Invalid value for option 'teal.plot_dpi', therefore defaulting to", default_dpi, "dpi"))
611	4x	dpi <- default_dpi
612		}
613	38x	dpi
614		}
615
616		#' Print plot for download functionality
617		#'
618		#' @param plot (`reactive`)\cr
619		#' reactive expression to draw a plot
620		#' @param plot_type (`reactive`)\cr
621		#' reactive plot type (`gg`, `trel`, `grob`, `other`)
622		#'
623		#' @return Nothing returned, the plot is printed.
624		#' @keywords internal
625		#'
626		print_plot <- function(plot, plot_type) {
627	25x	switch(plot_type(),
628	2x	"grob" = grid::grid.draw(plot()),
629		"other" = {
630	2x	graphics::plot.new()
631	2x	graphics::text(
632	2x	x = graphics::grconvertX(0.5, from = "npc"),
633	2x	y = graphics::grconvertY(0.5, from = "npc"),
634	2x	labels = "This plot graphic type is not yet supported to download"
635		)
636		},
637	17x	"base" = plot(),
638	4x	print(plot())
639		)
640		}

1		#' @keywords internal
2		#' @noRd
3		table_with_settings_deps <- function() {
4	1x	htmltools::htmlDependency(
5	1x	name = "teal-widgets-table-with-settings",
6	1x	version = utils::packageVersion("teal.widgets"),
7	1x	package = "teal.widgets",
8	1x	src = "table-with-settings",
9	1x	stylesheet = "table-with-settings.css"
10		)
11		}
12
13		#' @name table_with_settings
14		#'
15		#' @title `table_with_settings` module
16		#'
17		#' @description `r lifecycle::badge("stable")`\cr
18		#' Module designed to create a `shiny` table output based on `rtable` object (`ElementaryTable` or `TableTree`) input.
19		#' @inheritParams shiny::moduleServer
20		#' @param ... (`character`)\cr
21		#' Useful for providing additional HTML classes for the output tag.
22		#'
23		#' @rdname table_with_settings
24		#' @export
25		#'
26		table_with_settings_ui <- function(id, ...) {
27	1x	checkmate::assert_string(id)
28
29	1x	ns <- NS(id)
30
31	1x	tags$div(
32	1x	table_with_settings_deps(),
33	1x	shinyjs::useShinyjs(),
34	1x	bslib::card(
35	1x	id = ns("table-with-settings"),
36	1x	full_screen = TRUE,
37	1x	tags$div(
38	1x	class = "teal-widgets settings-buttons",
39	1x	bslib::tooltip(
40	1x	trigger = tags$div(type_download_ui_table(ns("downbutton"))),
41	1x	options = list(trigger = "hover"),
42	1x	class = "download-button",
43	1x	"Download"
44		)
45		),
46	1x	tags$div(
47	1x	class = "teal-widgets table-content",
48	1x	uiOutput(ns("table_out_main"), width = "100%", ...)
49		)
50		)
51		)
52		}
53
54		#' @inheritParams shiny::moduleServer
55		#' @param table_r (`reactive`)\cr
56		#' reactive expression that yields an `rtable` object (`ElementaryTable` or `TableTree`)
57		#' @param show_hide_signal (`reactive logical`) optional\cr
58		#' mechanism to allow modules which call this module to show/hide the table_with_settings UI.
59		#'
60		#' @rdname table_with_settings
61		#'
62		#' @return A `shiny` module.
63		#'
64		#' @export
65		#'
66		#' @examples
67		#' library(shiny)
68		#' library(rtables)
69		#' library(magrittr)
70		#'
71		#' ui <- bslib::page_fluid(
72		#' table_with_settings_ui(
73		#' id = "table_with_settings"
74		#' )
75		#' )
76		#'
77		#' server <- function(input, output, session) {
78		#' table_r <- reactive({
79		#' l <- basic_table() %>%
80		#' split_cols_by("ARM") %>%
81		#' analyze(c("SEX", "AGE"))
82		#'
83		#' tbl <- build_table(l, DM)
84		#'
85		#' tbl
86		#' })
87		#'
88		#' table_with_settings_srv(id = "table_with_settings", table_r = table_r)
89		#' }
90		#'
91		#' if (interactive()) {
92		#' shinyApp(ui, server)
93		#' }
94		#'
95		table_with_settings_srv <- function(id, table_r, show_hide_signal = reactive(TRUE)) {
96	5x	checkmate::assert_class(table_r, c("reactive", "function"))
97	4x	checkmate::assert_class(show_hide_signal, c("reactive", "function"))
98
99	3x	if (!requireNamespace("rtables", quietly = TRUE)) {
100	!	stop("package rtables is required, please install")
101		}
102
103	3x	moduleServer(id, function(input, output, session) {
104	3x	ns <- session$ns
105		# Turn on and off the UI
106	3x	observeEvent(show_hide_signal(), {
107	3x	if (show_hide_signal()) {
108	2x	shinyjs::show("table-with-settings")
109		} else {
110	1x	shinyjs::hide("table-with-settings")
111		}
112		})
113
114	3x	output$table_out_main <- output$table_out_modal <- renderUI({
115	6x	rtables::as_html(table_r())
116		})
117
118	3x	type_download_srv_table(
119	3x	id = "downbutton",
120	3x	table_reactive = table_r
121		)
122		})
123		}
124
125		type_download_ui_table <- function(id) {
126	1x	ns <- NS(id)
127	1x	bslib::popover(
128	1x	icon("download"),
129	1x	tags$div(
130	1x	radioButtons(ns("file_format"),
131	1x	label = "File type",
132	1x	choices = c("formatted txt" = ".txt", "csv" = ".csv", "pdf" = ".pdf"),
133		),
134	1x	textInput(ns("file_name"),
135	1x	label = "File name (without extension)",
136	1x	value = paste0("table_", strftime(Sys.time(), format = "%Y%m%d_%H%M%S"))
137		),
138	1x	conditionalPanel(
139	1x	condition = paste0("input['", ns("file_format"), "'] != '.csv'"),
140	1x	tags$div(
141	1x	class = "lock-btn",
142	1x	title = "on / off",
143	1x	shinyWidgets::prettyToggle(
144	1x	ns("pagination_switch"),
145	1x	value = FALSE,
146	1x	label_on = NULL,
147	1x	label_off = NULL,
148	1x	status_on = "default",
149	1x	status_off = "default",
150	1x	outline = FALSE,
151	1x	plain = TRUE,
152	1x	icon_on = icon("fas fa-toggle-off"),
153	1x	icon_off = icon("fas fa-toggle-on"),
154	1x	animation = "pulse"
155		)
156		),
157	1x	tags$div(
158	1x	class = "paginate-ui",
159	1x	shinyWidgets::numericInputIcon(
160	1x	inputId = ns("lpp"),
161	1x	label = "Paginate table:",
162	1x	value = 70,
163	1x	icon = list("lines / page")
164		),
165	1x	uiOutput(ns("lpp_warning"))
166		)
167		),
168	1x	conditionalPanel(
169	1x	condition = paste0("input['", ns("file_name"), "'] != ''"),
170	1x	downloadButton(ns("data_download"), label = character(0), class = "btn-sm w-full")
171		)
172		)
173		)
174		}
175
176		type_download_srv_table <- function(id, table_reactive) {
177	9x	moduleServer(
178	9x	id,
179	9x	function(input, output, session) {
180	9x	observeEvent(input$pagination_switch, {
181	13x	if (input$pagination_switch) {
182	7x	shinyjs::enable("lpp")
183		} else {
184	6x	shinyjs::disable("lpp")
185		}
186		})
187
188	9x	output$lpp_warning <- renderUI({
189	28x	catch_warning <- if (input$file_format != ".csv" && input$pagination_switch) {
190	9x	try(rtables::paginate_table(
191	9x	tt = table_reactive(),
192	9x	lpp = as.numeric(input$lpp)
193	9x	), silent = TRUE)
194		}
195
196	21x	if (inherits(catch_warning, "try-error")) {
197	4x	helpText(
198	4x	class = "error",
199	4x	icon("triangle-exclamation"),
200	4x	"Maximum lines per page includes the reprinted header. Please enter a numeric value or increase the value."
201		)
202		}
203		})
204
205	9x	output$data_download <- downloadHandler(
206	9x	filename = function() {
207	22x	paste0(input$file_name, input$file_format)
208		},
209	9x	content = function(file) {
210	22x	if (input$file_format == ".txt") {
211	8x	rtables::export_as_txt(
212	8x	x = table_reactive(),
213	8x	file = file,
214	8x	paginate = input$pagination_switch,
215	8x	lpp = if (input$pagination_switch) as.numeric(input$lpp)
216		)
217	14x	} else if (input$file_format == ".csv") {
218	7x	result <- rtables::matrix_form(table_reactive())$strings
219	7x	utils::write.table(
220	7x	x = result,
221	7x	file = file,
222	7x	sep = ",",
223	7x	col.names = FALSE,
224	7x	row.names = TRUE,
225	7x	append = FALSE
226		)
227		} else {
228	7x	rtables::export_as_pdf(
229	7x	x = table_reactive(),
230	7x	file = file,
231	7x	paginate = input$pagination_switch,
232	7x	lpp = if (input$pagination_switch) as.numeric(input$lpp)
233		)
234		}
235		}
236		)
237		}
238		)
239		}

1		#' @keywords internal
2		#' @noRd
3		draggable_buckets_deps <- function() {
4	!	htmltools::htmlDependency(
5	!	name = "teal-widgets-draggable-buckets",
6	!	version = utils::packageVersion("teal.widgets"),
7	!	package = "teal.widgets",
8	!	src = "draggable-buckets",
9	!	script = "draggable-buckets.js",
10	!	stylesheet = "draggable-buckets.css"
11		)
12		}
13
14		#' @title Draggable Buckets
15		#' @description `r lifecycle::badge("experimental")`
16		#' A custom widget with draggable elements that can be put into buckets.
17		#'
18		#' @param input_id (`character(1)`) the `HTML` id of this widget
19		#' @param label (`character(1)` or `shiny.tag`) the header of this widget
20		#' @param elements (`character`) the elements to drag into buckets
21		#' @param buckets (`character` or `list`) the names of the buckets the elements can be put in or a list of key-pair
22		#' values where key is a name of a bucket and value is a character vector of elements in a bucket
23		#'
24		#' @return the `HTML` code comprising an instance of this widget
25		#' @export
26		#'
27		#' @details `shinyvalidate` validation can be used with this widget. See example below.
28		#'
29		#' @examples
30		#' library(shiny)
31		#'
32		#' ui <- bslib::page_fluid(
33		#' draggable_buckets("id", "Choices #1", c("a", "b"), c("bucket1", "bucket2")),
34		#' draggable_buckets("id2", "Choices #2", letters, c("vowels", "consonants")),
35		#' verbatimTextOutput("out"),
36		#' verbatimTextOutput("out2")
37		#' )
38		#' server <- function(input, output) {
39		#' iv <- shinyvalidate::InputValidator$new()
40		#' iv$add_rule(
41		#' "id",
42		#' function(data) if (length(data[["bucket1"]]) == 0) "There should be stuff in bucket 1"
43		#' )
44		#' iv$enable()
45		#'
46		#' observeEvent(list(input$id, input$id2), {
47		#' print(isolate(input$id))
48		#' print(isolate(input$id2))
49		#' })
50		#' output$out <- renderPrint({
51		#' iv$is_valid()
52		#' input$id
53		#' })
54		#' output$out2 <- renderPrint(input$id2)
55		#' }
56		#' if (interactive()) shinyApp(ui, server)
57		#'
58		#' # With default elements in the bucket
59		#' ui <- bslib::page_fluid(
60		#' draggable_buckets("id", "Choices #1", c("a", "b"), list(bucket1 = character(), bucket2 = c("c"))),
61		#' verbatimTextOutput("out")
62		#' )
63		#' server <- function(input, output) {
64		#' observeEvent(input$id, {
65		#' print(isolate(input$id))
66		#' })
67		#' output$out <- renderPrint(input$id)
68		#' }
69		#' if (interactive()) shinyApp(ui, server)
70		draggable_buckets <- function(input_id, label, elements = character(), buckets) {
71	!	checkmate::assert_string(input_id)
72	!	checkmate::assert_true(inherits(label, "character") \|\| inherits(label, "shiny.tag"))
73	!	checkmate::assert_character(c(elements, unlist(buckets)), min.len = 0, null.ok = TRUE, unique = TRUE)
74	!	checkmate::assert(
75	!	checkmate::check_character(buckets, min.len = 1),
76	!	checkmate::check_list(buckets, types = "character", names = "unique")
77		)
78
79	!	elements_iterator <- new.env(parent = emptyenv())
80	!	elements_iterator$it <- 0
81
82	!	shiny::tagList(
83	!	draggable_buckets_deps(),
84	!	shiny::div(
85	!	tags$span(label),
86	!	render_unbucketed_elements(elements = elements, elements_iterator = elements_iterator, widget_id = input_id),
87	!	render_buckets(buckets = buckets, elements_iterator = elements_iterator, widget_id = input_id),
88	!	class = "draggableBuckets",
89	!	id = input_id
90		)
91		)
92		}
93
94		render_unbucketed_elements <- function(elements, elements_iterator, widget_id) {
95	!	tags$div(
96	!	lapply(elements, function(element) {
97	!	elements_iterator$it <- elements_iterator$it + 1
98	!	render_draggable_element(
99	!	value = element,
100	!	id = paste0(widget_id, "draggable", elements_iterator$it),
101	!	widget_id = widget_id
102		)
103		}),
104	!	id = paste0(widget_id, "elements"),
105	!	class = c("form-control", "elements"),
106	!	ondragover = "allowDrop(event)",
107	!	ondrop = "drop(event)",
108	!	`data-widget` = widget_id
109		)
110		}
111
112		render_buckets <- function(buckets, elements_iterator, widget_id) {
113	!	buckets <- `if`(
114	!	is.list(buckets),
115	!	lapply(names(buckets), function(bucket_name) {
116	!	render_bucket(
117	!	name = bucket_name,
118	!	elements = buckets[[bucket_name]],
119	!	elements_iterator = elements_iterator,
120	!	widget_id = widget_id
121		)
122		}),
123	!	lapply(buckets, render_bucket, widget_id = widget_id, elements_iterator = elements_iterator)
124		)
125	!	shiny::tagList(buckets)
126		}
127
128		render_draggable_element <- function(value, id, widget_id) {
129	!	tags$div(
130	!	value,
131	!	id = id,
132	!	class = "element",
133	!	draggable = "true",
134	!	ondragstart = "drag(event)",
135	!	ondragover = "allowDrop(event)",
136	!	ondrop = "dropReorder(event)",
137	!	`data-widget` = widget_id
138		)
139		}
140
141		render_bucket <- function(name, elements = NULL, elements_iterator = NULL, widget_id = NULL) {
142	!	tags$div(
143	!	tags$div(
144	!	paste0(name, ":"),
145	!	class = "bucket-name",
146	!	ondragover = "allowDrop(event)",
147	!	ondrop = "dropBucketName(event)",
148	!	`data-widget` = widget_id
149		),
150	!	lapply(elements, function(element) {
151	!	elements_iterator$it <- elements_iterator$it + 1
152	!	render_draggable_element(
153	!	value = element,
154	!	id = paste0(widget_id, "draggable", elements_iterator$it),
155	!	widget_id = widget_id
156		)
157		}),
158	!	class = c("form-control", "bucket"),
159	!	ondragover = "allowDrop(event)",
160	!	ondrop = "drop(event)",
161	!	`data-label` = name,
162	!	`data-widget` = widget_id
163		)
164		}

1		#' This function checks the plot type and applies specific modifications
2		#' to the plot object based on the provided parameters.
3		#'
4		#' @param plot_obj The original plot object.
5		#' @param plot_type The type of the plot, either `gg` (`ggplot2`) or `grob` (`grid`, `graphics`).
6		#' @param dblclicking A logical value indicating whether double-clicking on data points on
7		#' the main plot is enabled or disabled.
8		#' @param ranges A list containing x and y values of ranges.
9		#'
10		#' @keywords internal
11		apply_plot_modifications <- function(plot_obj, plot_type, dblclicking, ranges) {
12	11x	if (plot_type == "gg" && dblclicking) {
13	1x	plot_obj +
14	1x	ggplot2::coord_cartesian(xlim = ranges$x, ylim = ranges$y, expand = FALSE)
15	10x	} else if (plot_type == "grob") {
16	2x	grid::grid.newpage()
17	2x	grid::grid.draw(plot_obj)
18		} else {
19	8x	plot_obj
20		}
21		}
22
23		#' This function opens a PDF graphics device using [grDevices::pdf()] to suppress
24		#' the plot display in the IDE. The purpose of this function is to avoid opening graphic devices
25		#' directly in the IDE.
26		#'
27		#' @param x lazy binding which generates the plot(s)
28		#'
29		#' @keywords internal
30		plot_suppress <- function(x) {
31	27x	grDevices::pdf(nullfile())
32	27x	on.exit(grDevices::dev.off())
33	27x	force(x)
34		}

1		#' Panel group widget
2		#'
3		#' @description `r lifecycle::badge("deprecated")`\cr
4		#' Designed to group [`panel_item`] elements. Used to handle `shiny` inputs in the encoding panel.
5		#' @param id optional, (`character`)\cr
6		#' @param ... (`shiny.tag`)\cr
7		#' panels created by [panel_group()]
8		#'
9		#' @return (`shiny.tag`)
10		#'
11		#' @examples
12		#'
13		#' library(shiny)
14		#' panel_group(
15		#' panel_item(
16		#' title = "Display",
17		#' collapsed = FALSE,
18		#' checkboxGroupInput(
19		#' "check",
20		#' "Tables display",
21		#' choices = LETTERS[1:3],
22		#' selected = LETTERS[1]
23		#' ),
24		#' radioButtons(
25		#' "radio",
26		#' label = "Plot type",
27		#' choices = letters[1:2],
28		#' selected = letters[1]
29		#' )
30		#' ),
31		#' panel_item(
32		#' title = "Pre-processing",
33		#' radioButtons(
34		#' "filtering",
35		#' "What to filter",
36		#' choices = LETTERS[1:4],
37		#' selected = LETTERS[1]
38		#' ),
39		#' radioButtons(
40		#' "na_action",
41		#' "NA action",
42		#' choices = letters[1:3],
43		#' selected = letters[1]
44		#' )
45		#' )
46		#' )
47		#'
48		#' @export
49		panel_group <- function(..., id = NULL) {
50	!	lifecycle::deprecate_soft(
51	!	when = "0.4.3",
52	!	what = "panel_group()",
53	!	details = paste(
54	!	"The `panel_group()` and `panel_item()` view can be achieved by using the `bslib` package.",
55	!	"Please use the `bslib::accordion()` and `bslib::accordion_panel()` functions instead.",
56	!	"This function will be removed in the next release."
57		)
58		)
59	!	checkmate::assert_string(id, null.ok = TRUE)
60
61		# panel-group
62		# div
63
64	!	bslib::accordion(
65		...
66		)
67		}
68
69		#' @keywords internal
70		#' @noRd
71		panel_item_deps <- function() {
72	!	htmltools::htmlDependency(
73	!	name = "teal-widgets-panel-item",
74	!	version = utils::packageVersion("teal.widgets"),
75	!	package = "teal.widgets",
76	!	src = "panel-item",
77	!	script = "panel-item.js",
78	!	stylesheet = "panel-item.css"
79		)
80		}
81
82		#' Panel item widget
83		#'
84		#' @description `r lifecycle::badge("deprecated")`\cr
85		#' Designed to be grouped using [`panel_group`] element. Used to handle `shiny` inputs in the encoding panel.
86		#' @param title (`character`)\cr title of panel
87		#' @param ... content of panel
88		#' @param collapsed (`logical`) optional,\cr
89		#' whether to initially collapse panel
90		#' @param input_id (`character`) optional\cr
91		#' name of the panel item element. If supplied, this will register a shiny input variable that
92		#' indicates whether the panel item is open or collapsed and is accessed with `input$input_id`.
93		#'
94		#' @return (`shiny.tag`)
95		#'
96		#' @examples
97		#'
98		#' library(shiny)
99		#' panel_item(
100		#' title = "Display",
101		#' collapsed = FALSE,
102		#' checkboxGroupInput(
103		#' "check",
104		#' "Tables display",
105		#' choices = LETTERS[1:3],
106		#' selected = LETTERS[1]
107		#' ),
108		#' radioButtons(
109		#' "radio",
110		#' label = "Plot type",
111		#' choices = letters[1:2],
112		#' selected = letters[1]
113		#' )
114		#' )
115		#'
116		#' @export
117		panel_item <- function(title, ..., collapsed = TRUE, input_id = NULL) {
118	!	lifecycle::deprecate_soft(
119	!	when = "0.4.3",
120	!	what = "panel_item()",
121	!	details = paste(
122	!	"The `panel_group()` and `panel_item()` view can be achieved by using the `bslib` package.",
123	!	"Please use the `bslib::accordion()` and `bslib::accordion_panel()` functions instead.",
124	!	"This function will be removed in the next release."
125		)
126		)
127	!	stopifnot(checkmate::test_character(title, len = 1) \|\| inherits(title, c("shiny.tag", "shiny.tag.list", "html")))
128	!	checkmate::assert_flag(collapsed)
129	!	checkmate::assert_string(input_id, null.ok = TRUE)
130
131	!	bslib::accordion_panel(
132	!	id = input_id,
133	!	title = title,
134	!	open = !collapsed,
135		...
136		)
137		}

1		#' @keywords internal
2		#' @noRd
3		standard_layout_deps <- function() {
4	1x	htmltools::htmlDependency(
5	1x	name = "teal-widgets-standard-layout",
6	1x	version = utils::packageVersion("teal.widgets"),
7	1x	package = "teal.widgets",
8	1x	src = "standard-layout",
9	1x	stylesheet = "standard-layout.css"
10		)
11		}
12
13		#' Standard UI layout
14		#'
15		#' @description `r lifecycle::badge("stable")`\cr
16		#' Create a standard UI layout with output on the right and an encoding panel on
17		#' the left. This is the layout used by the `teal` modules.
18		#'
19		#' @param output (`shiny.tag`)\cr
20		#' object with the output element (table, plot, listing) such as for example returned
21		#' by [shiny::plotOutput()].
22		#' @param encoding (`shiny.tag`)\cr
23		#' object containing the encoding elements. If this element is `NULL` then no encoding side
24		#' panel on the right is created.
25		#' @param forms (`tagList`)\cr
26		#' for example [shiny::actionButton()] that are placed below the encodings panel
27		#' @param pre_output (`shiny.tag`) optional,\cr
28		#' with text placed before the output to put the output into context. For example a title.
29		#' @param post_output (`shiny.tag`) optional, with text placed after the output to put the output
30		#' into context. For example the [shiny::helpText()] elements are useful.
31		#'
32		#' @return an object of class `shiny.tag` with the UI code.
33		#'
34		#' @examples
35		#' library(shiny)
36		#' standard_layout(
37		#' output = white_small_well(tags$h3("Tests")),
38		#' encoding = tags$div(
39		#' tags$label("Encodings", class = "text-primary"),
40		#' panel_item(
41		#' "Tests",
42		#' optionalSelectInput(
43		#' "tests",
44		#' "Tests:",
45		#' choices = c(
46		#' "Shapiro-Wilk",
47		#' "Kolmogorov-Smirnov (one-sample)"
48		#' ),
49		#' selected = "Shapiro-Wilk"
50		#' )
51		#' )
52		#' ),
53		#' forms = tagList(
54		#' verbatim_popup_ui("warning", "Show Warnings"),
55		#' verbatim_popup_ui("rcode", "Show R code")
56		#' )
57		#' )
58		#'
59		#' @export
60		standard_layout <- function(output,
61		encoding = NULL,
62		forms = NULL,
63		pre_output = NULL,
64		post_output = NULL) {
65		# checking arguments
66	6x	checkmate::assert_multi_class(output, c("shiny.tag", "shiny.tag.list", "html"))
67	4x	checkmate::assert_multi_class(encoding, c("shiny.tag", "shiny.tag.list", "html"), null.ok = TRUE)
68	3x	checkmate::assert_multi_class(pre_output, c("shiny.tag", "shiny.tag.list", "html"), null.ok = TRUE)
69	2x	checkmate::assert_multi_class(post_output, c("shiny.tag", "shiny.tag.list", "html"), null.ok = TRUE)
70
71		# if encoding=NULL then forms is placed below output
72
73	1x	tag_output <- tags$div(
74	1x	class = "teal-widgets standard-layout",
75	1x	tags$div(class = "standard-layout-pre-output", pre_output),
76	1x	tags$div(class = "standard-layout-output", output),
77	1x	tags$div(class = "standard-layout-post-output", post_output)
78		)
79
80	1x	tag_enc_out <- if (!is.null(encoding)) {
81	!	tags$div(
82	!	class = "teal-widgets standard-layout has-encodings",
83	!	bslib::layout_sidebar(
84	!	sidebar = bslib::sidebar(
85	!	tags$div(
86	!	encoding,
87	!	if (is.null(forms)) {
88	!	NULL
89		} else {
90	!	tags$div(
91	!	tags$br(),
92	!	forms
93		)
94		}
95		)
96		),
97	!	tag_output
98		)
99		)
100		} else {
101	1x	tags$div(
102	1x	tag_output,
103	1x	if (is.null(forms)) {
104	1x	NULL
105		} else {
106	!	tags$div(class = "form-group", forms)
107		}
108		)
109		}
110
111	1x	bslib::page_fluid(
112	1x	class = "teal-widgets standard-layout-wrapper",
113	1x	standard_layout_deps(),
114	1x	tag_enc_out
115		)
116		}

1		#' Builds a `basic_table_args` object
2		#'
3		#' @description `r lifecycle::badge("experimental")`
4		#' This function has to be used to build an input for a `basic_table_args` argument.
5		#' The `basic_table_args` argument should be a part of every module which contains any `rtables` object.
6		#' Arguments are validated to match their `rtables` equivalents.
7		#'
8		#' For more details see the vignette: `vignette("custom-basic-table-arguments", package = "teal.widgets")`.
9		#'
10		#' @seealso
11		#' * [resolve_basic_table_args()] to resolve multiple objects into one using pre-defined priorities.
12		#' * [parse_basic_table_args()] to parse resolved list into list of calls.
13		#'
14		#' @param ... arguments compatible with [rtables::basic_table()].
15		#'
16		#' @return (`basic_table_args`) object.
17		#' @export
18		#' @examples
19		#' basic_table_args(subtitles = "SUBTITLE")
20		basic_table_args <- function(...) {
21	118x	table_args_l <- list(...)
22	118x	checkmate::assert_character(names(table_args_l), unique = TRUE, null.ok = TRUE)
23
24	118x	basic_table_formals <- methods::formalArgs(rtables::basic_table)
25	118x	checkmate::assert_subset(names(table_args_l), choices = basic_table_formals, empty.ok = TRUE)
26
27	114x	structure(table_args_l, class = "basic_table_args")
28		}
29
30		#' Resolves and reduces multiple `basic_table_args` objects
31		#'
32		#' @description `r lifecycle::badge("experimental")`
33		#' Resolving and reducing multiple `basic_table_args` objects.
34		#' This function is intended to utilize user provided settings, defaults provided by the module creator and
35		#' also `teal` option. See `Details`, below, to understand the logic.
36		#'
37		#' @seealso [parse_basic_table_args()] to parse resolved list into list of calls.
38		#'
39		#' @param user_table (`basic_table_args`)\cr
40		#' end user setup for [rtables::basic_table()] of a specific table.
41		#' Created with the [basic_table_args()] function. The `NULL` value is supported.
42		#' @param user_default (`basic_table_args`)\cr
43		#' end user default setup for [rtables::basic_table()]
44		#' of a specific table. Created with the [basic_table_args()] function. The `NULL` value is supported.
45		#' @param module_table (`ggplot2_args`)\cr
46		#' module creator setup for [rtables::basic_table()] of a specific table.
47		#' Created with the [basic_table_args()] function. The `NULL` value is supported.
48		#' @param app_default (`basic_table_args`)\cr
49		#' Application level setting. Can be `NULL`.
50		#'
51		#' @return `basic_table_args` object.
52		#' @details
53		#' The function picks the first non `NULL` value for each argument, checking in the following order:
54		#' 1. `basic_table_args` argument provided by the end user.
55		#' Per table (`user_table`) and then default (`user_default`) setup.
56		#' 2. `app_default` global R variable, `teal.basic_table_args`.
57		#' 3. `module_table` which is a module creator setup.
58		#' @export
59		#' @examples
60		#' resolve_basic_table_args(
61		#' user_table = basic_table_args(title = "TITLE"),
62		#' user_default = basic_table_args(title = "DEFAULT_TITLE", subtitles = "SUBTITLE")
63		#' )
64		resolve_basic_table_args <- function(user_table = basic_table_args(),
65		user_default = basic_table_args(),
66		module_table = basic_table_args(),
67		app_default = getOption("teal.basic_table_args", basic_table_args())) {
68	24x	checkmate::assert_class(user_table, "basic_table_args", null.ok = TRUE)
69	23x	checkmate::assert_class(user_default, "basic_table_args", null.ok = TRUE)
70	23x	checkmate::assert_class(module_table, "basic_table_args", null.ok = TRUE)
71	23x	checkmate::assert_class(app_default, "basic_table_args", null.ok = TRUE)
72
73	23x	table_args_all <- list(
74	23x	"table" = user_table,
75	23x	"default" = user_default,
76	23x	"teal" = app_default,
77	23x	"module" = module_table
78		)
79
80	23x	table_args_f <- Reduce(`c`, table_args_all)
81
82	23x	if (length(table_args_f) == 0) {
83	9x	basic_table_args()
84		} else {
85	14x	do.call(basic_table_args, table_args_f[!duplicated(names(table_args_f))])
86		}
87		}
88
89		#' Parses `basic_table_args` object into the `basic_table` expression
90		#'
91		#' @description `r lifecycle::badge("experimental")`
92		#' A function to parse expression from the `basic_table_args` object.
93		#' @param basic_table_args (`basic_table_args`)\cr
94		#' This argument could be a result of the [`resolve_basic_table_args()`].
95		#'
96		#' @return (`language`) the `rtables::basic_table()` filled with additional arguments.
97		#' @export
98		#' @examples
99		#' parse_basic_table_args(
100		#' resolve_basic_table_args(
101		#' user_table = basic_table_args(title = "TITLE"),
102		#' user_default = basic_table_args(title = "DEFAULT_TITLE", subtitles = "SUBTITLE")
103		#' )
104		#' )
105		parse_basic_table_args <- function(basic_table_args = teal.widgets::basic_table_args()) {
106	8x	checkmate::assert_class(basic_table_args, "basic_table_args", null.ok = TRUE)
107
108	7x	if (length(basic_table_args) == 0) {
109	3x	quote(rtables::basic_table())
110		} else {
111	4x	as.call(c(list(quote(rtables::basic_table)), basic_table_args))
112		}
113		}

1		#' Map `lenghtMenu` property
2		#'
3		#' @description `r lifecycle::badge("stable")`\cr
4		#' Maps the `lengthMenu` selected value property of `DT::datatable` to a `shiny` variable.
5		#' @param dt_name `ns()` of `inputId` of the `DT::datatable`
6		#' @param dt_rows `ns()` of `inputId` of the variable that holds the current selected value of `lengthMenu`
7		#'
8		#' @name get_dt_rows
9		#'
10		#' @return (`shiny::tagList`) A `shiny tagList`.
11		#'
12		#' @examplesIf require("DT")
13		#' library(shiny)
14		#' library(DT)
15		#'
16		#' ui <- function(id) {
17		#' ns <- NS(id)
18		#' tagList(
19		#' DTOutput(ns("data_table")),
20		#' get_dt_rows(ns("data_table"), ns("dt_rows"))
21		#' )
22		#' }
23		#'
24		#' # use the input$dt_rows in the Shiny Server function
25		#' server <- function(id) {
26		#' moduleServer(id, function(input, output, session) {
27		#' output$data_table <- renderDataTable(
28		#' {
29		#' iris
30		#' },
31		#' options = list(pageLength = input$dt_rows)
32		#' )
33		#' })
34		#' }
35		#'
36		#' if (interactive()) {
37		#' shinyApp(
38		#' ui = ui("my_table_module"),
39		#' server = function(input, output, session) server("my_table_module")
40		#' )
41		#' }
42		#' @export
43		get_dt_rows <- function(dt_name, dt_rows) {
44	!	tags$head(
45	!	tags$script(
46	!	sprintf(
47	!	"$(document).ready(function() {
48	!	$('%s').on('length.dt', function(e, settings, len) {
49	!	Shiny.onInputChange('%s', len);
50		});
51		});",
52	!	paste0("#", dt_name),
53	!	dt_rows
54		)
55		)
56		)
57		}

1		#' Small well class for HTML
2		#'
3		#' @description `r lifecycle::badge("stable")`\cr
4		#' Adds Small Well class and overflow-x property to HTML output element.
5		#' @param ... other arguments to pass to tag object's div attributes.
6		#'
7		#' @details `white_small_well` is intended to be used with [shiny::uiOutput()].
8		#' The overflow-x property is set to auto so that a scroll bar is added
9		#' when the content overflows at the left and right edges of the output window.
10		#' For example, this is useful for displaying wide tables.
11		#'
12		#' @return An HTML output element with class Small Well and overflow-x property
13		#' @export
14		#'
15		#' @examples
16		#'
17		#' white_small_well(shiny::htmlOutput("summary"))
18		white_small_well <- function(...) {
19	!	shiny::tagList(
20	!	tags$div(
21	!	class = "well well-sm",
22	!	style = "background-color: white;",
23		...
24		)
25		)
26		}