bump to version 1.0.1 (new parameter max_images for dashboard)

Author: stm

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: imagefluency
 Type: Package
 Title: Image Statistics Based on Processing Fluency
-Version: 1.0.0
+Version: 1.0.1
 Authors@R: person(given = "Stefan", family = "Mayer", email = "stefan@mayer-de.com",
     role = c("aut", "cre"), comment = c(ORCID = "0000-0003-0034-7090"))
 Description: Get image statistics based on processing fluency theory. The

NEWS.md

@@ -1,5 +1,9 @@
 # imagefluency
 
+# imagefluency 1.0.1
+
+* `run_imagefluency()` gains a `max_images` parameter to control the maximum number of images that can be uploaded in the Shiny app (default: 100).
+
 # imagefluency 1.0.0
 
 * redesigned the Shiny dashboard with multi-image upload, integrated

R/imagefluencyApp.R

@@ -1,10 +1,16 @@
 #' @include utils.R
 NULL
 
-#' Run imagefluency app
+#' Interactive dashboard for \code{imagefluency}
 #'
-#' Launches a Shiny app that shows a demo of what can be done with
-#' the \code{imagefluency} package.
+#' Launches a dashboard to interactively use the functions of the
+#' \code{imagefluency} package. The dashboard is built using the \code{shiny}
+#' package and provides a user-friendly interface for uploading images,
+#' analyzing them, and exporting the results. The dashboard supports
+#' multi-image uploads and side-by-side comparisons of image fluency scores.
+#'
+#' @param max_images Integer. Maximum number of images that can be uploaded.
+#'   Defaults to 100.
 #'
 #' @export
 #'
@@ -13,14 +19,23 @@ NULL
 #' ## Only run this example in interactive R sessions
 #' if (interactive()) {
 #'   run_imagefluency()
+#'
+#'   # increase the maximum number of uploadable images to 150
+#'   run_imagefluency(max_images = 150)
 #' }
-run_imagefluency <- function() {
+run_imagefluency <- function(max_images = 100) {
   appDir <- system.file("imagefluencyApp", package = "imagefluency")
   if (appDir == "") {
     stop("Could not find shiny app directory. Try re-installing `imagefluency`.", call. = FALSE)
   }
 
+  if (!is.numeric(max_images) || max_images < 1) {
+    stop("`max_images` must be a positive number.", call. = FALSE)
+  }
+
   if (requireNamespace("shiny", quietly = TRUE)) {
+    options(imagefluency.max_images = as.integer(max_images))
+    on.exit(options(imagefluency.max_images = NULL), add = TRUE)
     shiny::runApp(appDir, display.mode = "normal")
   } else {
     stop("Package 'shiny' is required but not installed on your system.", call. = FALSE)

inst/imagefluencyApp/app.R

@@ -2,7 +2,7 @@
 NULL
 
 # Configuration
-MAX_IMAGES <- 100
+MAX_IMAGES <- getOption("imagefluency.max_images", default = 100L)
 
 # Default (demo) image
 defaultimage <- system.file("imagefluencyApp", "www", "rails.jpg", package = "imagefluency")

man/run_imagefluency.Rd

@@ -17,3 +17,10 @@ test_that("run_imagefluency launches shiny app when available", {
 
   expect_identical(run_imagefluency(), "launched")
 })
+
+test_that("run_imagefluency errors on invalid max_images", {
+  expect_error(run_imagefluency(max_images = 0),
+               "`max_images` must be a positive number\\.")
+  expect_error(run_imagefluency(max_images = "ten"),
+               "`max_images` must be a positive number\\.")
+})