R/mod_sn_search_wikidata.R

In giocomai/streetnamer: Match street names to their Wikidata identifier with a Shiny interface

#' sn_search_wikidata UI Function
#'
#' @description A shiny Module.
#'
#' @param id,input,output,session Internal parameters for {shiny}.
#'
#' @noRd
#'
#' @importFrom shiny NS tagList
mod_sn_search_wikidata_ui <- function(id) {
  ns <- shiny::NS(id)

  shiny::tagList(
    shiny::uiOutput(outputId = ns("search_input_box_ui")),
    shiny::uiOutput(outputId = ns("repeat_input_ui")),
    DT::DTOutput(outputId = ns("search_results_dt")),
    shiny::uiOutput(outputId = ns("search_language_ui"))
  )
}

#' sn_search_wikidata Server Functions
#'
#' @noRd
mod_sn_search_wikidata_server <- function(id,
                                          search_string = "",
                                          search_language,
                                          description_language,
                                          languages = streetnamer::sn_available_languages,
                                          connection = NULL,
                                          cache = FALSE) {
  moduleServer(id, function(input, output, session) {
    ns <- session$ns

    languages_v <- languages$language_code
    names(languages_v) <- languages$language_name

    search_results_df_r <- shiny::reactive({
      if (length(input$wikidata_search) == 0) {
        return(NULL)
      } else if (is.null(input$wikidata_search)) {
        return(NULL)
      } else if (is.na(input$wikidata_search)) {
        return(NULL)
      } else if (input$wikidata_search == "") {
        return(NULL)
      } else if (nchar(input$wikidata_search) > 0) {
        search_results_df <- tidywikidatar::tw_search(
          search = input$wikidata_search,
          language = dplyr::if_else(is.null(input$language_selector),
            search_language,
            input$language_selector
          ),
          response_language = input$language_description_selector,
          cache = cache,
          cache_connection = connection
        ) %>%
          dplyr::filter(is.na(id) == FALSE)
      }
      search_results_df
    })


    output$search_input_box_ui <- shiny::renderUI({
      shiny::tagList(
        shiny::textInput(
          inputId = ns("wikidata_search"),
          label = "Search on Wikidata",
          placeholder = "search...",
          value = search_string,
          width = "100%"
        )
      )
    })

    output$search_language_ui <- shiny::renderUI({
      tagList(
        fluidRow(
          column(
            width = 6,
            shiny::selectInput(
              inputId = ns("language_selector"),
              label = "Search language",
              choices = languages_v,
              selected = search_language,
              multiple = FALSE,
              selectize = TRUE
            )
          ),
          column(
            width = 6,
            shiny::selectInput(
              inputId = ns("language_description_selector"),
              label = "Description language",
              choices = languages_v,
              selected = description_language,
              multiple = FALSE,
              selectize = TRUE
            )
          )
        )
      )
    })

    output$search_results_dt <- DT::renderDT(
      expr = {
        search_results_df <- search_results_df_r()

        if (is.null(search_results_df)) {
          return(NULL)
        }

        if (nrow(search_results_df) == 0) {
          DT::datatable(
            data = tibble::tibble(`No results` = ""),
            options = list(
              dom = "t",
              pageLength = 1
            ),
            rownames = FALSE,
            escape = FALSE,
            selection = "single"
          )
        } else {
          DT::datatable(
            data = search_results_df %>%
              head(5) %>%
              dplyr::mutate(id = glue::glue("<a href='https://www.wikidata.org/wiki/{id}' target=\"_blank\">{id}</a>")),
            options = list(
              dom = "t",
              pageLength = 10
            ),
            rownames = FALSE,
            escape = FALSE,
            selection = "single"
          )
        }
      },
      server = TRUE
    )



    shiny::reactive(search_results_df_r()$id[input$search_results_dt_rows_selected])
  })
}

## To be copied in the UI
# mod_sn_search_wikidata_ui("sn_search_wikidata_ui_1")

## To be copied in the server
# mod_sn_search_wikidata_server("sn_search_wikidata_ui_1")


mod_sn_search_app <- function(search_string,
                              search_language,
                              description_language,
                              languages = streetnamer::sn_available_languages,
                              cache = FALSE,
                              connection = NULL,
                              testing = FALSE) {
  ui <- shiny::fluidPage(
    mod_sn_search_wikidata_ui(id = "sn_search_wikidata_ui_1"),
    shiny::uiOutput(outputId = "selected_named_after_id")
  )

  server <- function(input, output, session) {
    selected_named_after_id <- mod_sn_search_wikidata_server(
      id = "sn_search_wikidata_ui_1",
      search_string = search_string,
      search_language = search_language,
      description_language = description_language,
      languages = languages,
      cache = cache,
      connection = connection
    )


    output$selected_named_after_id <- shiny::renderUI({
      shiny::p(selected_named_after_id())
    })
  }
  shiny::shinyApp(ui, server)
}

# mod_sn_search_app(search_string = "example", search_language = "en",description_language = "en", cache = TRUE, connection = connection)