R/mod_special_wells.R

In wpm: Well Plate Maker

##'  UI part for module special wells
##'
##' @description UI part of the number of iterations module.
##' @param id internal parameter for {shiny}
##' @noRd
mod_special_wells_ui <- function(id){
    ns <- shiny::NS(id)
    shiny::fluidRow(
        shiny::column(
            width = 6,
            shinydashboard::box(
                status = "warning",
                width = 12,
                collapsible = TRUE,
                solidHeader = TRUE,
                title = shiny::h3(shiny::textOutput(ns("status"))),
                shiny::fluidRow(
                    shiny::column(
                        width = 10,
                        shiny::h4("Enter Line Letter & Column number, each box
                          separated by commas without spaces.")
                    ),
                    shiny::column(
                        width = 2,
                        align = "right",
                        shinyWidgets::dropdownButton(
                            shiny::div(shiny::textOutput(ns("help"))),
                            icon = shiny::icon("info-circle"),
                            tooltip = shinyWidgets::tooltipOptions(title = "Help"),
                            status = "warning",
                            size = "sm",
                            width = "350px"
                        )
                    )
                ),
                shiny::textInput(
                    ns("special_select"),
                    label = NULL,
                    value = NULL,
                    placeholder = "Ex: A1,B2,C3")
            ) # end of box
        )
    )
}


##'  Server part for module special wells
##'
##' @description server part of the number of iterations module. Converts the
##' character strings of special wells into a dataframe usable by the
##' backtracking algorithm
##'
##' @param input,output,session Internal {shiny} parameters
##' @param p_dimensions a reactiveValues object contianing the number of lines
##' (nb_lines) and number of columns (nb_cols)
##' @return a `reactiveValues` object containing a datarfmae of special wells.
##' @noRd
mod_special_wells_server <- function(input, output, session, status, p_dimensions){
    toReturn <- shiny::reactiveValues(
        wells = NULL
    )
    if (status == "forbidden") {
        output$status <- shiny::renderText({
            "Forbidden Wells"
        })
        output$help <- shiny::renderText({
            "'Forbidden' means that the wells in question will not be filled at
            all in the final plate plan. Consequently, during
            the experiment, these will be completely empty wells. WPM color
            them in red on the plots."
        })

    }else if (status == "fixed") {
        output$status <- shiny::renderText({
            "Fixed Wells"
        })

        output$help <- shiny::renderText({
            "These samples will not be used for the backtracking algorithm.
            They correspond to Quality controls or Standards. These wells are
            colored black on the plate map. Note that the 'forbidden' status
            has priority over the 'fixed' status, the wells already filled as
            'forbidden' will remain red. "
        })
    }

    p_lines <- shiny::reactive({
        return(p_dimensions$nb_lines)
    })

    p_cols <- shiny::reactive({
        return(p_dimensions$nb_cols)
    })

    special_wells <- shiny::reactive({
        ## if special wells have been entered, then we transform into a dataframe
        ## compatible with the rest of the code
        if (input$special_select != "") {
            return(convertVector2Df(input$special_select,
                                    p_lines(),
                                    p_cols(),
                                    status = status))
        }else{
            return(NULL)
        }
    })

    shiny::observe({
        toReturn$wells <- special_wells()
    })

    return(toReturn)
}