R/ifcb_run_image_gallery.R

In iRfcb: Tools for Managing Imaging FlowCytobot (IFCB) Data

#' Run IFCB Image Gallery
#'
#' @description
#' `r lifecycle::badge("deprecated")`
#'
#' This function was deprecated as there is a better alternative: `ClassiPyR::run_app()`. For more information,
#' please see: <https://europeanifcbgroup.github.io/ClassiPyR/>
#'
#' Launches a Shiny application that provides an interactive interface for
#' browsing and managing IFCB (Imaging FlowCytobot) image galleries.
#'
#' Users can specify a folder containing .png images, navigate through the images,
#' select and unselect images, and download a list of selected images.
#' This feature is particularly useful for quality control of annotated images.
#' A downloaded list of images from the app can also be uploaded to filter and
#' view only the selected images.
#'
#' @import shiny
#' @export
#'
#' @return No return value. This function launches a Shiny application for interactive image browsing and management.
#'
#' @examples
#' \donttest{
#' # Run the IFCB image gallery Shiny app
#' if(interactive()){
#'   ifcb_run_image_gallery()
#' }
#' }
ifcb_run_image_gallery <- function() {
  lifecycle::deprecate_warn(
    when = "0.7.0.9000",
    what = "ifcb_run_image_gallery()",
    with = "ClassiPyR::run_app()",
    details = "ClassiPyR is a better alternative, see: https://europeanifcbgroup.github.io/ClassiPyR/"
  )

  appDir <- system.file("shiny", "ifcb_image_gallery", package = "iRfcb")
  if (appDir == "") {
    stop("Could not find ifcb_image_gallery directory. Try re-installing `iRfcb`.", call. = FALSE)
  }

  shiny::runApp(appDir, display.mode = "normal")
}