R/runModularApp.R

In nprcgenekeepr: Genetic Tools for Colony Management

## Copyright(c) 2017-2026 R. Mark Sharp
## This file is part of nprcgenekeepr

#' Run the Modular Version of GeneKeepR (Deprecated)
#'
#' \code{runModularApp()} has been renamed to \code{\link{runGeneKeepR}}, a
#' name that says what the function does. \code{runModularApp()} is now a
#' soft-deprecated alias that launches the application via
#' \code{\link{runGeneKeepR}}. Existing callers continue to work.
#'
#' @param port Integer port number for the Shiny server (default 6013)
#' @param launch.browser Logical; whether to launch browser (default TRUE)
#'
#' @return Returns the error condition of the Shiny application when it
#'   terminates (from \code{\link{runGeneKeepR}}).
#'
#' @seealso \code{\link{runGeneKeepR}}, the function this now launches.
#' @export
#' @examples
#' \dontrun{
#' library(nprcgenekeepr)
#' runModularApp()
#' }
runModularApp <- function(port = 6013L, launch.browser = TRUE) { # nolint: object_name_linter
  lifecycle::deprecate_soft(
    when = "2.0.0",
    what = "runModularApp()",
    with = "runGeneKeepR()",
    details = paste(
      "runModularApp() has been renamed;",
      "runGeneKeepR() now launches the application."
    )
  )
  runGeneKeepR(port = port, launch.browser = launch.browser)
}