teatimer: Play a Sound After Some Time

Description Usage Arguments Examples

Description

This is a one-function package that will play a sound after a specified interval of time. It wraps around the function beepr::beep(). After a specified number of minutes or seconds it plays whatever sound is specified. Because it uses Sys.sleep() and audio may not play immediately, timing may not be precise. This is, however, sufficiently accurate for use on a cup of tea. If beepr::beep() is not able to play the sound a warning is issued rather than an error.

Usage

1
teatimer(time = 1, minutes = TRUE, sound = 1)

Arguments

time

A positive number, the amount of time to wait

minutes

If TRUE, time is in minutes. If FALSE, time is in seconds.

sound

character string or number specifying what sound to be played by either specifying one of the built in sounds, specifying the path to a wav file or specifying an url. The default is 1, which plays a 'ping' sound from beepr::beep().. See the documentation for beep, as the input on this argument is passed directly to that function.

Examples

1
2
3
4
## Not run: 
teatimer(time = 0, minutes = TRUE, sound = 1)

## End(Not run)

gzt/teatimer documentation built on June 5, 2019, 3:10 p.m.