R/confirmGATquit.R

In ajstamm/gatpkg: Geographic Aggregation Tool (GAT)

#' Confirm Quitting GAT
#'
#' @description
#' This function opens a dialog window for the user to select whether to quit
#' or continue GAT.
#'
#' \figure{confirmGATquit.png}
#'
#' *Figure: Dialog to confirm quitting GAT*
#'
#' Click on one of the following buttons.
#'
#' * Click \code{Yes} if you would like to quit GAT.
#' * Click \code{No} if you do not want to quit GAT.
#'
#' @examples
#'
#' if (interactive()) {
#' # choose yes or no
#' confirmGATquit()
#' }
#'
#' @export

confirmGATquit <- function() {
  msg <- "Are you sure you want to quit?"
  x <- tcltk::tkmessageBox(title = "Program cancelled", message = msg,
                           type = "yesno", icon = "warning")
  x <- tcltk::tclvalue(x)
  x <- if (x == "yes") "quit" else if (x == "no") "continue"
  return(x)
}