Merge pull request #17 from EVS-GIS/documentation

add documentation panel and link website

R/app_server.R

@@ -8,4 +8,5 @@
 app_server <- function(input, output, session) {
   # Your application server logic
   mod_explore_server("explore_1")
+  mod_documentation_server("documentation_1")
 }

R/app_ui.R

@@ -10,7 +10,10 @@ app_ui <- function(request){
     theme = bs_theme(version = 5, bootswatch = "simplex"),
     title =
         img(src = "www/favicon_mapdo.png"),
-    tabPanel("Exploration", mod_explore_ui("explore_1"))
+    tabPanel("Exploration", mod_explore_ui("explore_1")),
+    tabPanel("Documentation",
+             icon = icon("info"),
+             mod_documentation_ui("documentation_1"))
   )
 }
 

R/mod_documentation.R

@@ -0,0 +1,39 @@
+#' documentation UI Function
+#'
+#' @description A shiny Module.
+#'
+#' @param id,input,output,session Internal parameters for {shiny}.
+#'
+#' @noRd
+#'
+#' @import shiny
+mod_documentation_ui <- function(id){
+  ns <- NS(id)
+  tagList(
+    golem_add_external_resources(),
+    fluidPage(
+      tags$a(
+        href = "https://evs-gis.github.io/mapdowebsite/",
+        icon("book"),
+        "Documentation",
+        target = "_blank"
+      )
+    )
+  )
+}
+
+#' documentation Server Functions
+#'
+#' @noRd
+mod_documentation_server <- function(id){
+  moduleServer( id, function(input, output, session){
+    ns <- session$ns
+
+  })
+}
+
+## To be copied in the UI
+# mod_documentation_ui("documentation_1")
+
+## To be copied in the server
+# mod_documentation_server("documentation_1")

R/mod_explore.R

@@ -18,7 +18,6 @@ mod_explore_ui <- function(id){
   tagList(
     # Leave this function for adding external resources
     golem_add_external_resources(),
-    # UI elements
     fluidPage(
       useShinyjs(),
       tags$head(

dev/02_dev.R

@@ -35,8 +35,8 @@ shiny::reactlogShow()
 
 ## Add modules ----
 ## Create a module infrastructure in R/
-golem::add_module(name = "explore_test", with_test = TRUE) # Name of the module
-golem::add_module(name = "name_of_module2", with_test = TRUE) # Name of the module
+golem::add_module(name = "explore", with_test = TRUE) # Name of the module
+golem::add_module(name = "documentation", with_test = TRUE) # Name of the module
 
 ## Add dependencies
 

tests/testthat/test-mod_documentation.R

@@ -0,0 +1,38 @@
+testServer(
+  mod_documentation_server,
+  # Add here your module params
+  args = list()
+  , {
+    ns <- session$ns
+    expect_true(
+      inherits(ns, "function")
+    )
+    expect_true(
+      grepl(id, ns(""))
+    )
+    expect_true(
+      grepl("test", ns("test"))
+    )
+    # Here are some examples of tests you can
+    # run on your module
+    # - Testing the setting of inputs
+    # session$setInputs(x = 1)
+    # expect_true(input$x == 1)
+    # - If ever your input updates a reactiveValues
+    # - Note that this reactiveValues must be passed
+    # - to the testServer function via args = list()
+    # expect_true(r$x == 1)
+    # - Testing output
+    # expect_true(inherits(output$tbl$html, "html"))
+})
+
+test_that("module ui works", {
+  ui <- mod_documentation_ui(id = "test")
+  golem::expect_shinytaglist(ui)
+  # Check that formals have not been removed
+  fmls <- formals(mod_documentation_ui)
+  for (i in c("id")){
+    expect_true(i %in% names(fmls))
+  }
+})
+