R/mod_ng_charts.R

In vdes2020/eneRgyVD: Municipal statistics for climate-related policies, Canton de Vaud (Switzerland)

#' ng_charts UI Function
#'
#' @description A shiny Module made for natural gas distribution dataset
#'
#' @param id,input,output,session Internal parameters for {shiny}.
#'
#' @noRd
#'
#' @importFrom shiny NS tagList
mod_ng_charts_ui <- function(id,
                             title,
                             title_complement){
  ns <- NS(id)
  tagList(

    # Header ----
    # div to handle title + accordion layout
    tags$div(
      # Large+ screens : inline, flex layout, justified items
      #  smaller screens : row by row (default layout without fill)
      class = "d-flex justify-content-start",
      # Title (w small padding to avoid it touching the accordion)
      h4(title, style = "padding-right:3vw;"),

      # Methodology button
      actionButton(ns("ng_cons_help"),
                   class = "btnCustom",
                   label = tags$span(style = "font-weight:500;",
                                     "Source et méthode",
                                     bslib::tooltip(
                                       id = ns("tooltip_data_help"),
                                       placement = "right",
                                       options = list(customClass = "customTooltips"), # custom.scss
                                       trigger = phosphoricons::ph(title = NULL, "info"),
                                       generic_method_warning # utils_text_and_links.R
                                     )
                   ))
    ),#End div

    # utils_text_and_links.R
    title_complement,

    # Pills ----

    bslib::navset_pill(
      header = br(), # blank line to space content (alternative would be to add padding)

      ### Graph ----
      bslib::nav_panel(title = "Graphique",
                       icon = phosphoricons::ph(title = NULL, "chart-bar"),


                       bslib::layout_columns(col_widths = c(-2, 4, 4, -2),
                                             class = "fs-materialSwitch",


                                             # materialSwitch 1/2 for bar plot
                                             shiny::conditionalPanel(
                                               # Commune condition in server must be reached
                                               condition = "output.commune",
                                               ns = ns,

                                               tags$div(
                                                 tags$div(
                                                   class = "align-middle",
                                                   shinyWidgets::materialSwitch(
                                                     inputId = ns("stacked_status"),
                                                     value = FALSE,
                                                     status = "success",
                                                     label = strong("Barres empilées", class = "align-middle"),
                                                     inline = TRUE),
                                                   tags$span(strong("adjacentes", class = "align-middle"))
                                                 ))# End 2x tags$div()
                                             ),# End conditionalPanel 1/2

                                             # materialSwitch 2/2 for bar plot
                                             shiny::conditionalPanel(
                                               # Toggle condition in server must be reached
                                               condition = "output.toggle",
                                               ns = ns,

                                               tags$div(
                                                 shinyWidgets::materialSwitch(
                                                   inputId = ns("toggle_status"),
                                                   value = FALSE,
                                                   label = strong("Axe vertical commun", class = "align-middle"),
                                                   status = "success",
                                                   inline = TRUE),
                                                 tags$span(strong("indépendant", class = "align-middle"))
                                               )# End tags$div
                                             ),# End 2nd conditionalPanel

                       ),#End layout_column_wrap() for buttons


                       # renderPlotly
                       ggiraph::girafeOutput(ns("chart_1")) |>
                         shinycssloaders::withSpinner(type = 6,
                                                      color= main_color) # color defined in utils_helpers.R




      ),# End nav_panel('Graphique')

      ### Table ----
      bslib::nav_panel(title = "Table",
                       icon = phosphoricons::ph(title = NULL, "table"),

                       # Download buttons
                       mod_download_data_ui(ns("table_download")),

                       # rt table
                       DT::dataTableOutput(ns("table_1"))


      )# End nav_panel() 'Table'
    )#End navset_pill()
  )# End tagList()
}

#' ng_charts Server Functions
#'
#' @noRd
mod_ng_charts_server <- function(id,
                                 subsetData, # passed from inputVals, bit redundant but clear
                                 inputVals,
                                 var_commune,
                                 var_year,
                                 var_cat,
                                 var_values,
                                 color_palette,
                                 dl_prefix = dl_prefix,
                                 doc_vars = doc_vars
){ # the non-reactive documentation file for variables description
  moduleServer(id, function(input, output, session){
    ns <- session$ns

    # Initialize toggle free_y condition for conditionalPanel in ui
    output$toggle <- reactive({length(unique(subsetData()$commune)) > 1})

    # Initialize toggle stacked condition for conditionalPanel in ui
    output$commune <- reactive({length(unique(subsetData()$commune)) > 0})

    # We don't suspend output$toggle when hidden (default is TRUE)
    outputOptions(output, 'toggle', suspendWhenHidden = FALSE)
    outputOptions(output, 'commune', suspendWhenHidden = FALSE)

    # Plot logic ----

    output$chart_1 <- ggiraph::renderGirafe({

      validate(need(inputVals$selectedCommunes, req_communes_phrase))
      req(subsetData())

      # Compute number of rows
      num_facets <- length(unique(subsetData()$commune))
      num_columns <- 2
      num_rows <- ceiling(num_facets / num_columns)  # Calculate rows needed for 2 columns

      # Dynamic height and width ratios (unitless)
      base_height_per_row <- 2  # Adjust height ratio per row

      # Save units passed to create_plot_ggiraph()
      height_svg <- 2 + (num_rows * base_height_per_row)  # Height grows with the number of rows
      width_svg <- 15  # Keep width static for two columns layout

      # fct is defined in fct_helpers.R
      create_plot_ggiraph(data = subsetData(),
                         n_communes = dplyr::n_distinct(subsetData()$commune),
                         var_year = var_year,
                         var_commune = var_commune,
                         unit = inputVals$energyUnit,
                         var_cat = var_cat,
                         var_values = var_values,
                         geom = "col",
                         color_palette = color_palette, # defined in utils_helpers.R
                         dodge = input$stacked_status, # if T -> 'dodge', F -> 'stack'
                         free_y = input$toggle_status, # reactive(input$toggle_status)
                         legend_title = "Secteur : ", # links to ifelse in facet_wrap(scales = ...)
                         height_svg = height_svg, # px width of browser when app starts
                         width_svg = width_svg # px height of browser when app starts
      )
    })# End renderGirafe


    # Table logic ----

    # rt table
    output$table_1 <- DT::renderDataTable({

      validate(need(inputVals$selectedCommunes, req_communes_phrase))

      # ng needs are the same as electricity consumption
      make_table_dt(
        data = subsetData(),
        var_commune = var_commune,
        var_year = var_year,
        var_values = var_values,
        var_cat = var_cat,
        icons_palette = cons_icons,
        unit = inputVals$energyUnit
      )
    })

    # Download logic ----

    # store the data in a reactive (not sure why we can't pass subsetData it directly, but otherwise this won't work)

    download_data <- reactive({

      # Add first the current unit and then make colnames nicelly formatted
      subsetData() |>
        add_colname_unit(colnames = "consommation",
                         unit = inputVals$energyUnit) |>
        rename_columns_output()


    })

    # Module to download DT table data
    mod_download_data_server("table_download",
                             inputVals = inputVals,
                             data = download_data,
                             dl_prefix = dl_prefix,
                             doc_vars = doc_vars) # dl prefix for file name, passed from app_server.R


  })
} # End server


## To be copied in the UI
# mod_ng_charts_ui("generic_charts_1")

## To be copied in the server
# mod_ng_charts_server("generic_charts_1")