The package that sounds as it is called.
R
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
R
inst/sounds
man
.Rbuildignore
.gitignore
DESCRIPTION
NAMESPACE
NEWS
README.md
beepr.Rproj
cran-comments.md

README.md

beepr: Easily Play Notification Sounds on any Platform

beepr is an R package that contains one main function, beep(), with one purpose: To make it easy to play notification sounds on whatever platform you are on. It is intended to be useful, for example, if you are running a long analysis in the background and want to know when it is ready.

A derivative function, beep_on_error(), wraps an expression and will only beep if an error occurs when that expression is evaluated.

This package was previously called pingr and included a ping() function. It has been renamed in order to not be confused with the Unix tool ping. For the rationale behind beepr see the original announcement: http://sumsar.net/blog/2014/01/announcing-pingr/

Installation

beepr is available on CRAN and can be installed from within R by running:

install.packages("beepr")

You can also grab the development version of beepr directly from github:

library(devtools)
install_github("rasmusab/beepr")

Requirements

If you are using Windows or OS X beepr relies on the audio package for sound playback and no external program is needed.

If you're on Linux beepr relies on you having either the paplay utility from the Pulse Audio system, the aplay utility from the ALSA system or VLC media player installed and on the PATH. Chances are that you alread have one of these. If you are on Debian/Ubuntu you can otherwise get VLC by running the following in a terminal:

sudo apt-get install vlc

Details

beep() plays a short sound which is useful if you want to get notified, for example, when a script has finished. As an added bonus there are a number of different sounds to choose from.

Usage

beep(sound = 1, expr = NULL)

Arguments

sound character string or number specifying what sound to be played by either specifying one of the built in sounds or specifying the path to a wav file. The default is 1. Possible sounds are:

  1. "ping"
  2. "coin"
  3. "fanfare"
  4. "complete"
  5. "treasure"
  6. "ready"
  7. "shotgun"
  8. "mario"
  9. "wilhelm"
  10. "facebook"
  11. "sword"

If sound does not match any of the sounds above, or is a valid path, a random sound will be played.

expr An optional expression to be executed before the sound.

Examples

# Update all packages and "ping" when it's ready
update.packages(ask=FALSE); beep()

#Play a fanfare instead of a "ping".
beep("fanfare")
#or
beep(3)

# Play a random sound
beep(0)

# Play a sound if an error occurs
beep_on_error(1 + "a", sound = "wilhelm")