inst/app/tools/app/help.R

In radiant-rstats/radiant.data: Data Menu for Radiant: Business Analytics using R and Shiny

#######################################
## Other elements in help menu
#######################################
output$help_videos <- renderUI({
  file.path(getOption("radiant.path.data"), "app/tools/app/tutorials.md") %>% inclMD() %>% HTML()
})

output$help_about <- renderUI({
  file.path(getOption("radiant.path.data"), "app/tools/app/about.md") %>% inclMD() %>% HTML()
})

output$help_text <- renderUI({
  wellPanel(
    HTML("Help is available on each page by clicking the <i title='Help' class='fa fa-question'></i> icon on the bottom left of your screen.<br><br>Versions: ", getOption("radiant.versions", default = "Unknown"))
  )
})

#######################################
## Main function of help menu
#######################################
append_help <- function(help_str, help_path, lic = "nc", Rmd = TRUE) {
  if (length(input[[help_str]]) == 0) return()
  help_block <- get(help_str)
  local_hd <- help_block[which(help_block %in% input[[help_str]])]
  all_help <- c()
  for (i in names(local_hd)) {
    all_help <- paste(
      all_help, paste0("<h2>", i, "</h2>"),
      inclRmd(file.path(help_path, local_hd[i])),
      sep = "\n"
    )
  }
  mathjax_script <- ifelse(Rmd, "<script>if (window.MathJax) MathJax.Hub.Typeset();</script>", "")

  if (lic == "nc") {
    cc <- getOption("radiant.help.cc", default = "")
  } else {
    cc <- getOption("radiant.help.cc.sa", default = "")
  }

  ## remove ` from report.md
  paste(
    gsub("(\"> )`", "\\1", all_help) %>%
    gsub("`( </td>)", "\\1", .),
    "\n", mathjax_script, "\n", cc
  ) %>% HTML()
}

help_switch <- function(help_all, help_str, help_on = TRUE) {
  if (is.null(help_all) || help_all == 0) return()
  help_choices <- help_init <- get(help_str)
  init <- ""
  if (help_on) init <- help_init
  updateCheckboxGroupInput(
    session, help_str,
    label = NULL,
    choices = help_choices,
    selected = init, inline = TRUE
  )
}

help_data <- c(
  "Manage" = "manage.md", "View" = "view.md", "Visualize" = "visualize.md",
  "Pivot" = "pivotr.md", "Explore" = "explore.md", "Transform" = "transform.md",
  "Combine" = "combine.md", "Report > Rmd" = "report_rmd.md", "Report > R" = "report_r.md"
)
output$help_data <- reactive(
  append_help("help_data", file.path(getOption("radiant.path.data"), "app/tools/help/"))
)

observeEvent(input$help_data_all, {
  help_switch(input$help_data_all, "help_data")
})
observeEvent(input$help_data_none, {
  help_switch(input$help_data_none, "help_data", help_on = FALSE)
})

help_data_panel <-
  wellPanel(
    HTML(
      "<label>Data menu: <i id='help_data_all' title='Check all' href='#' class='action-button glyphicon glyphicon-ok'></i>
       <i id='help_data_none' title='Uncheck all' href='#' class='action-button glyphicon glyphicon-remove'></i></label>"
    ),
    checkboxGroupInput("help_data", NULL, help_data, selected = state_group("help_data"), inline = TRUE)
  )

output$help_data_ui <- renderUI({
  sidebarLayout(
    sidebarPanel(
      help_data_panel,
      uiOutput("help_text"),
      width = 3
    ),
    mainPanel(
      HTML(paste0("<h2>Select help files to show and search</h2><hr>")),
      htmlOutput("help_data")
    )
  )
})

observeEvent(input$help_keyboard, {
  showModal(
    modalDialog(
      title = "Keyboard shortcuts",
      h4("General"),
      ## based on https://github.com/swarm-lab/editR/blob/master/inst/app/bits/keyboard.R
      withTags(
        table(style = "width: 80%; margin-left: 10%;",
          tr(class = "border_bottom",
             td(b("Function")), td(b("Mac")), td(b("Windows & Linux"))),
          tr(class = "padding_top",
             td("Save state"), td("Shift-CMD-s"), td("Shift-CTRL-s")),
          tr(class = "padding_top",
             td("Open state"), td("Shift-CMD-o"), td("Shift-CTRL-o")),
          tr(class = "border_bottom padding_bottom",
             td("Show help"), td("F1"), td("F1")),
          tr(class = "border_bottom padding_bottom",
             td("Generate screenshot"), td("CMD-p"), td("CTRL-p")),
          tr(class = "border_bottom padding_bottom",
             td("Generate code"), td("ALT-return"), td("ALT-return")),
          tr(class = "border_bottom padding_bottom",
             td("Estimate/Run (green button)"), td("CMD-enter"), td("CTRL-enter")),
          tr(class = "border_bottom padding_bottom",
             td("Save (blue button)"), td("CMD-s"), td("CTRL-s")),
          tr(class = "border_bottom padding_bottom",
             td("Download (blue icon)"), td("CMD-s"), td("CTRL-s")),
          tr(class = "border_bottom padding_bottom",
             td("Load (blue button)"), td("CMD-o"), td("CTRL-o"))
          # tr(class = "border_bottom padding_bottom",
             # td("Viewer pane full screen"), td("Shift-CTRL-9"), td("Shift-CTRL-9"))
        )
      ),
      footer = modalButton("OK"),
      size = "l",
      easyClose = TRUE
    )
  )
})