R/Studio_Tabs_DM_CreateTextDataSet.R

In aifeducation: Artificial Intelligence for Education

# This file is part of the R package "aifeducation".
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3 as published by
# the Free Software Foundation.
#
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>

#' @title Graphical user interface for data management
#' @description Functions generates the page for creating [LargeDataSetForText].
#'
#' @param id `string` determining the id for the namespace.
#' @return This function does nothing return. It is used to build a page for a shiny app.
#'
#' @family studio_gui_page_data_management
#' @keywords internal
#' @noRd
#'

DataManagement_RawTextsUI <- function(id) {
  shiny::tagList(
    bslib::page_sidebar(
      sidebar = bslib::sidebar(
        shiny::tags$h3("Control Panel"),
        shinyFiles::shinyDirButton(
          id = shiny::NS(id, "start_SaveModal"),
          label = "Create Data Set",
          title = "Choose Destination",
          icon = shiny::icon("floppy-disk")
        )
      ),
      bslib::page(
        shiny::fluidRow(
          shiny::column(
            width = 4,
            bslib::card(
              bslib::card_header("Text Sources"),
              bslib::card_body(
                width = "33%",
                shinyFiles::shinyDirButton(
                  id = shiny::NS(id, "source_dir_select"),
                  label = "Choose Folder",
                  title = "Please choose a folder",
                  icon = shiny::icon("folder-open")
                ),
                shiny::textInput(
                  inputId = shiny::NS(id, "text_source_dir"),
                  label = shiny::tags$p(shiny::icon("folder"), "Path to Folder")
                )
              )
            )
          ),
          shiny::column(
            width = 8,
            bslib::card(
              bslib::card_header("File Types"),
              bslib::card_body(
                bslib::card(
                  bslib::card_body(
                    width = "33%",
                    shinyWidgets::materialSwitch(
                      inputId = shiny::NS(id, "include_txt"),
                      label = shiny::tags$p("Include .txt ", shiny::icon(name = "file")),
                      right = TRUE,
                      inline = FALSE,
                      value = TRUE,
                      status = "primary"
                    )
                  )
                ),
                bslib::card(
                  bslib::card_body(
                    shinyWidgets::materialSwitch(
                      inputId = shiny::NS(id, "include_pdf"),
                      label = shiny::tags$p("Include .pdf", shiny::icon(name = "file-pdf")),
                      right = TRUE,
                      inline = FALSE,
                      value = FALSE,
                      status = "primary"
                    )
                  )
                ),
                bslib::card(
                  bslib::card_body(
                    shinyWidgets::materialSwitch(
                      inputId = shiny::NS(id, "include_xlsx"),
                      label = shiny::tags$p("Include .xlsx", shiny::icon(name = "file-excel")),
                      right = TRUE,
                      inline = FALSE,
                      value = FALSE,
                      status = "primary"
                    ),
                    bslib::layout_column_wrap(
                      width = 1 / 2,
                      shiny::textInput(
                        inputId = shiny::NS(id, "excel_id_column"),
                        label = shiny::HTML("Name of <b>ID column</b>"),
                        value = "id"
                      ),
                      shiny::textInput(
                        inputId = shiny::NS(id, "excel_text_column"),
                        label = shiny::HTML("Name of <b>text column</b>"),
                        value = "text"
                      ),
                      shiny::textInput(
                        inputId = shiny::NS(id, "excel_license_column"),
                        label = shiny::HTML("Name of <b>license column</b>"),
                        value = "license"
                      ),
                      shiny::textInput(
                        inputId = shiny::NS(id, "excel_bib_entry_column"),
                        label = shiny::HTML("Name of <b>bib entry column</b>"),
                        value = "bib_entry"
                      ),
                      shiny::textInput(
                        inputId = shiny::NS(id, "excel_url_license_column"),
                        label = shiny::HTML("Name of <b>url license column</b>"),
                        value = "url_license"
                      ),
                      shiny::textInput(
                        inputId = shiny::NS(id, "excel_text_license_column"),
                        label = shiny::HTML("Name of <b>text license column</b>"),
                        value = "text_license"
                      ),
                      shiny::textInput(
                        inputId = shiny::NS(id, "excel_url_source_column"),
                        label = shiny::HTML("Name of <b>url source column</b>"),
                        value = "url_source"
                      )
                    )
                  )
                )
              )
            )
          )
        )

      )
    )
  )
}

#' @title Server function for: graphical user interface for data management
#' @description Functions generates the functionality of a page on the server.
#'
#' @param id `string` determining the id for the namespace.
#' @param log_dir `string` Path to the directory where the log files should be stored.
#' @param volumes `vector` containing a named vector of available volumes.
#' @return This function does nothing return. It is used to create the functionality of a page for a shiny app.
#'
#' @family studio_gui_page_data_management
#' @keywords internal
#' @noRd
#'
DataManagement_RawTextsServer <- function(id, log_dir, volumes) {
  shiny::moduleServer(id, function(input, output, session) {
    # local variables------------------------------------------------------------
    log_path <- paste0(log_dir, "/aifeducation_state.log")

    # File system management----------------------------------------------------
    shinyFiles::shinyDirChoose(
      input = input,
      id = "source_dir_select",
      roots = volumes,
      allowDirCreate = FALSE
    )
    shiny::observeEvent(input$source_dir_select, {
      shiny::updateTextInput(
        inputId = "text_source_dir",
        value = shinyFiles::parseDirPath(volumes, input$source_dir_select)
      )
    })

    # Start screen for choosing the location for storing the data set-----------
    # Create Save Modal
    save_modal <- create_save_modal(
      id = id,
      title = "Choose Destination",
      easy_close = FALSE,
      size = "l"
    )

    # Implement file connection
    shinyFiles::shinyDirChoose(
      input = input,
      id = "start_SaveModal",
      roots = volumes,
      allowDirCreate = TRUE
    )

    # show save_modal
    shiny::observeEvent(input$start_SaveModal, {
      path <- shinyFiles::parseDirPath(volumes, input$start_SaveModal)
      if (!is.null(path) && !identical(path, character(0)) && path != "") {
        shiny::showModal(save_modal)
        shiny::updateTextInput(
          inputId = "save_modal_directory_path",
          value = path
        )
      }
    })

    # Implement Algorithm--------------------------------------------------------
    # button_continue comes from the SaveModal
    shiny::observeEvent(input$save_modal_button_continue, {
      #Remove Save Modal
      shiny::removeModal()

      # Check for errors
      errors <- check_errors_create_dataset_raw_texts(
        source_path = input$text_source_dir,
        destination_path = input$save_modal_directory_path,
        folder_name = input$save_modal_folder_name,
        include_txt = input$include_txt,
        include_pdf = input$include_pdf,
        include_xlsx = input$include_xlsx,
        excel_id_column = input$excel_id_column,
        excel_text_column = input$excel_text_column,
        excel_license_column = input$excel_license_column,
        excel_bib_entry_column = input$excel_bib_entry_column,
        excel_url_license_column = input$excel_url_license_column,
        excel_text_license_column = input$excel_text_license_column,
        excel_url_source_column = input$excel_url_source_column
      )

      # If there are errors display them. If not start running task.
      if (!is.null(errors)) {
        display_errors(
          title = "Error",
          size = "l",
          easy_close = TRUE,
          error_messages = errors
        )
      } else {
        # Start task and monitor
        start_and_monitor_long_task(
          id = id,
          ExtendedTask_type = "raw_texts",
          ExtendedTask_arguments = list(
            source_path = input$text_source_dir,
            destination_path = input$save_modal_directory_path,
            destination_folder = input$save_modal_folder_name,
            log_path = log_path,
            include_txt = input$include_txt,
            include_pdf = input$include_pdf,
            include_xlsx = input$include_xlsx,
            excel_id_column = input$excel_id_column,
            excel_text_column = input$excel_text_column,
            excel_license_column = input$excel_license_column,
            excel_bib_entry_column = input$excel_bib_entry_column,
            excel_url_license_column = input$excel_url_license_column,
            excel_text_license_column = input$excel_text_license_column,
            excel_url_source_column = input$excel_url_source_column,
            log_write_interval = 2
          ),
          log_path = log_path,
          pgr_use_middle = TRUE,
          pgr_use_bottom = FALSE,
          update_intervall = 2,
          success_type = "data_sets"
        )
      }
    })
    #--------------------------------------------------------------------------
  })
}