Inserted code and tests

Author: GuidoMaggio

DESCRIPTION

@@ -7,9 +7,15 @@ License: MIT + file LICENSE
 Imports: 
     config (>= 0.3.2),
     golem (>= 0.4.1),
+    graphics,
     shiny (>= 1.8.1.1)
 Encoding: UTF-8
 LazyData: true
-RoxygenNote: 7.1.1
+RoxygenNote: 7.3.1
 URL: https://github.com/guidomaggioorg/shinyfaithful
 BugReports: https://github.com/guidomaggioorg/shinyfaithful/issues
+Suggests: 
+    spelling,
+    testthat (>= 3.0.0)
+Config/testthat/edition: 3
+Language: en-US

NAMESPACE

@@ -7,4 +7,5 @@ importFrom(golem,add_resource_path)
 importFrom(golem,bundle_resources)
 importFrom(golem,favicon)
 importFrom(golem,with_golem_options)
+importFrom(graphics,hist)
 importFrom(shiny,shinyApp)

R/app_server.R

@@ -6,4 +6,5 @@
 #' @noRd
 app_server <- function(input, output, session) {
   # Your application server logic
+  mod_faithful_hist_server("hist")
 }

R/app_ui.R

@@ -10,7 +10,8 @@ app_ui <- function(request) {
     golem_add_external_resources(),
     # Your application UI logic
     fluidPage(
-      h1("shinyfaithful")
+      h1("Old Faithful Geyser - Hist"),
+      mod_faithful_hist_ui("hist")
     )
   )
 }

R/mod_faithful_hist.R

@@ -0,0 +1,52 @@
+#' Old Faithful histogram Shiny module
+#'
+#' @description UI and server function for an example Shiny module.
+#'
+#' @param id Internal parameter for {shiny}.
+#'
+#' @name mod_faithful_hist
+#'
+NULL
+
+#' @rdname mod_faithful_hist
+#'
+#' @import shiny
+mod_faithful_hist_ui <- function(id) {
+  ns <- NS(id)
+  tagList(
+    fluidRow(
+      column(3,
+             sliderInput(ns("bins"), "Number of bins:", min = 1, max = 50, value = 30),
+             checkboxInput(ns("density"), label = "density")
+      ),
+      # Show a plot of the generated distribution
+      column(9,
+             plotOutput(ns("distPlot"))
+      )
+    )
+  )
+}
+
+#' @rdname mod_faithful_hist
+#'
+#' @import shiny
+mod_faithful_hist_server <- function(id){
+  moduleServer( id, function(input, output, session){
+    ns <- session$ns
+    # generate bins based on input$bins from ui.R
+    variable <- "waiting"
+    x    <- datasets::faithful[, variable, drop = FALSE]
+    bins <- reactive(seq(min(x), max(x), length.out = input$bins + 1))
+
+    output$distPlot <- renderPlot({
+      # draw the histogram with the specified number of bins
+      plot_hist(x = x, breaks = bins(), freq = !input$density)
+    })
+  })
+}
+
+## To be copied in the UI
+# mod_faithful_hist_ui("faithful_hist_1")
+
+## To be copied in the server
+# mod_faithful_hist_server("faithful_hist_1")

R/plot_hist.R

@@ -0,0 +1,16 @@
+#' plot histogram
+#' @description function to plot histogram
+#'
+#' @param x data.frame to plot
+#' @param breaks a vector giving the breakpoints between histogram cells, as of graphics::hist
+#' @param freq logical for plotting frequencies, as of graphics::hist
+#'
+#' @importFrom graphics hist
+plot_hist <- function(x, breaks, freq){
+  variable <- names(x)[1] # take first variable
+  hist(
+    x[,variable], breaks = breaks, freq = freq,
+    main = paste("Histogram of", variable),
+    col = "darkgray", border = "white", xlab = variable
+  )
+}

inst/WORDLIST

@@ -0,0 +1,2 @@
+golem
+th

man/figures/README-pressure-1.png

@@ -0,0 +1,3 @@
+if(requireNamespace('spelling', quietly = TRUE))
+  spelling::spell_check_test(vignettes = TRUE, error = FALSE,
+                             skip_on_cran = TRUE)

man/mod_faithful_hist.Rd

@@ -0,0 +1,12 @@
+# This file is part of the standard setup for testthat.
+# It is recommended that you do not modify it.
+#
+# Where should you do additional test configuration?
+# Learn more about the roles of various files in:
+# * https://r-pkgs.org/testing-design.html#sec-tests-files-overview
+# * https://testthat.r-lib.org/articles/special-files.html
+
+library(testthat)
+library(shinyfaithful)
+
+test_check("shinyfaithful")

man/plot_hist.Rd

@@ -0,0 +1,74 @@
+test_that("app ui", {
+  ui <- app_ui()
+  golem::expect_shinytaglist(ui)
+  # Check that formals have not been removed
+  fmls <- formals(app_ui)
+  for (i in c("request")) {
+    expect_true(i %in% names(fmls))
+  }
+})
+
+test_that("app server", {
+  server <- app_server
+  expect_type(server, "closure")
+  # Check that formals have not been removed
+  fmls <- formals(app_server)
+  for (i in c("input", "output", "session")) {
+    expect_true(i %in% names(fmls))
+  }
+})
+
+test_that(
+  "app_sys works",
+  {
+    expect_true(
+      app_sys("golem-config.yml") != ""
+    )
+  }
+)
+
+test_that(
+  "golem-config works",
+  {
+    config_file <- app_sys("golem-config.yml")
+    skip_if(config_file == "")
+
+    expect_true(
+      get_golem_config(
+        "app_prod",
+        config = "production",
+        file = config_file
+      )
+    )
+    expect_false(
+      get_golem_config(
+        "app_prod",
+        config = "dev",
+        file = config_file
+      )
+    )
+  }
+)
+
+# Configure this test to fit your need.
+# testServer() function makes it possible to test code in server functions and modules, without needing to run the full Shiny application
+testServer(app_server, {
+
+  # Set and test an input
+  session$setInputs(x = 2)
+  expect_equal(input$x, 2)
+
+  # Example of tests you can do on the server:
+  # - Checking reactiveValues
+  # expect_equal(r$lg, 'EN')
+  # - Checking output
+  # expect_equal(output$txt, "Text")
+})
+
+# Configure this test to fit your need
+test_that(
+  "app launches",
+  {
+    golem::expect_running(sleep = 5)
+  }
+)

man/run_app.Rd

@@ -0,0 +1,10 @@
+test_that("plot_hist produces a plot", {
+  bins <- 30
+  x <- datasets::faithful[,"waiting", drop = FALSE]
+  p <- plot_hist(x = x,
+                 breaks = seq(min(x), max(x), length.out = bins + 1),
+                 freq = TRUE)
+  expect_visible(p)
+  expect_type(p, "list")
+  expect_s3_class(p, "histogram")
+})