R/gdp.R

In CorradoLanera/depigner: A Utility Package to Help you Deal with "Pignas"

#' GDP
#'
#' A wrapper to relax
#'
#' @param time [num] number of seconds needed to relax yourself
#'        (default = 4)
#' @param freq [num] rotating frequency (default = 0.05/s)
#'
#' @return invisible()
#' @export
#'
#' @examples
#' if (interactive()) {
#'   gdp()
#'
#'   gdp(5)
#'
#'   required_seconds_of_relax <- 10 # AKA: "conta fino a dieci!"
#'   rate_of_anxiety <- 1/1000       # AKA: "mi girano a mille!"
#'   gdp(required_seconds_of_relax, rate_of_anxiety)
#' }
gdp <- function(time = 4L, freq = 0.05) {
  my_seq <- seq_len(time / freq)

  pb <- progress::progress_bar[["new"]](
    format = "Please wait: :what :spin in corso...",
    total = length(my_seq),
    clear = TRUE,
    width = 76L
  )

  for (i in my_seq) {
    pb[["tick"]](tokens = list(what = "giramento di"))
    Sys.sleep(freq)
  }

  cat("\014")

  ui_done("Ahh... relaxed!")
  ui_todo("Now, feel free to continue working.")

  invisible("You are the power!")
}