闪亮模块:如果服务器功能失败,则销毁模块 ui

Shiny modules: Destroy module ui if server-function fails

如何显示空白UI(或者销毁模块UI),如果模块服务器功能失败,不移动所有UI代码到服务器功能?

简单的可重现示例:

library(shiny)

my_module_ui <- function(id) {
  ns <- NS(id)
  tags$div(
    tags$h1("Don't show me if my_module_server fails!"),
    plotOutput(ns("my_plot"))
  )
}

my_module_server <- function(input, output, session) {

  tryCatch({
    my_data <- cars * "A" # fail for demo
    # my_data <- cars

    output$my_plot <- renderPlot({
      cars2 <- my_data + rnorm(nrow(my_data))
      plot(cars2)
    })
  }, error=function(cond) {
    message("Destroy UI here!")
  })


}

ui <- fluidPage(
  my_module_ui("my_id")
)

server <- function(input, output, session) {
  callModule(my_module_server, "my_id")
}

shinyApp(ui, server)

我目前的解决方案是在 my_module_ui 中只包含一个 uiOutput(),并在服务器函数中呈现整个 ui。我想防止这种情况发生,因为如果所有 UI 组件都放在模块服务器功能中,那么大型模块会变得非常混乱。

此外,我还希望避免从 callModule() 返回破坏 UI 的值,而是从服务器函数内部执行此操作。

谢谢!

只要稍微重新排序代码,并使用神奇的 shinyjs package 就可以做到。

请注意,我添加了一个输入来模拟错误而不是错误,以查看 UI 是如何消失的。此外,所有操作都在模块的服务器部分完成。我希望这能帮到您。该代码包含解释这些步骤的内联注释。

library(shiny)
library(shinyjs)

my_module_ui <- function(id) {
  ns <- NS(id)

  tagList(
    # input added to be able to throw errors and see the ui dissapear
    selectInput(
      ns('trigger'), 'Error trigger',
      choices = list('no error' = c(2,1), 'error' = c('A', 'B')),
      selected = 2
    ),
    tags$div(
      # div with id, to select it with shinyjs and hide it if necessary
      id = ns('hideable_div'),
      tags$h1("Don't show me if my_module_server fails!"),
      plotOutput(ns("my_plot"))
    )
  )
}

my_module_server <- function(input, output, session) {

  # get all the things prone to error in a reactive call, that way you capture the final
  # result or a NULL reactive when an error occurs
  foo <- reactive({

    tryCatch({

      if (input$trigger %in% c(2,1)) {
        trigger <- as.numeric(input$trigger)
      } else {
        trigger <- input$trigger
      }

      cars * trigger
    }, error=function(cond) {
      message("Destroy UI here!")
    })
  })

  # obseveEvent based on the error reactive, to check if hide or not the UI
  observeEvent(foo(), {
    # hide checking if foo is null, using shinyjs
    if (is.null(foo())) {
      shinyjs::hide('hideable_div')
    } else {
      shinyjs::show('hideable_div')
    }
  }, ignoreNULL = FALSE, ignoreInit = FALSE)


  # outputs, with validation of the error reactive. That way code after validate is not
  # executed but the app does not get blocked (gray)
  output$my_plot <- renderPlot({
    shiny::validate(
      shiny::need(foo(), 'no data')
    )
    cars2 <- foo() + rnorm(nrow(foo()))
    plot(cars2)
  })

}

ui <- fluidPage(
  # really important for shinyjs tu work!!!!!!!
  shinyjs::useShinyjs(),
  my_module_ui("my_id")
)

server <- function(input, output, session) {
  callModule(my_module_server, "my_id")
}

shinyApp(ui, server)

在创建 UI(从服务器端通过 renderUI().

之前为会话对象分配一个值并计算该值如何?

1) 将 UI 的渲染移动到服务器端

在服务器端使用 renderUI(my_module_ui("my_id")),在 ui 端使用 uiOutput("module")

2)检测你的服务器模块是否成功给session对象赋值

my_module_server <- function(input, output, session) {
  tryCatch({
     ...
    session$userData$mod_server <- TRUE
  }, error = function(cond) {
    session$userData$mod_server <- NULL
  })
}

3) 使用此值使模块 ui 的调用有条件

  output$module <- renderUI({
    callModule(my_module_server, "my_id")
    if(!is.null(session$userData$mod_server)) my_module_ui("my_id")
  })

可重现的例子:

library(shiny)

my_module_ui <- function(id) {
  ns <- NS(id)
  tags$div(
    tags$h1("Don't show me if my_module_server fails!"),
    plotOutput(ns("my_plot"))
  )
}

my_module_server <- function(input, output, session) {
  tryCatch({
    my_data <- cars * "A" # fail for demo
    # my_data <- cars

    output$my_plot <- renderPlot({
      cars2 <- my_data + rnorm(nrow(my_data))
      plot(cars2)
    })
    session$userData$mod_server <- TRUE
  }, error = function(cond) {
    session$userData$mod_server <- NULL
  })
}

ui <- fluidPage(
  uiOutput("module")
)

server <- function(input, output, session) {
  output$module <- renderUI({
    callModule(my_module_server, "my_id")
    if(!is.null(session$userData$mod_server)) my_module_ui("my_id")
  })
}
shinyApp(ui, server)