workTimer: Countdown until stop work

View source: R/worktimr.R

workTimerR Documentation

Countdown until stop work

Description

Countdown minutes then do something.

Usage

workTimer(
  minutes = 25,
  outcome = "lock",
  con = "",
  timerMessage = "time until explosion: ",
  finalMessage = "IT'S OVER!"
)

Arguments

minutes

numeric

outcome

character naming one of "lock", "alarm", or "nothing"

con

character naming output text file

timerMessage

character display before countdown timer

finalMessage

character display when countdown expired

Details

What happens when to the time expires is specified by the outcome argument.

  • “lock” locks the screen

  • “alarm” plays an alarm sound

  • “nothing” nothing happens

If con is set to an empty character string the output is printed to the console. If a file is named the output is printing to a file, replacing the contents.

The outcome value “alarm” requires that VLC be installed at C:\Program Files\VideoLAN\VLC\vlc.exe on Windows. On Linux it requires vlc to be on the PATH. On Macos it expects VLC to be installed at /Applications/VLC.app.


anhinton/worktimr documentation built on Feb. 23, 2025, 7:17 p.m.