make_with_beep: Make a Beeping Plan!

In tiernanmartin/drakepkg: Demonstrate A Drake Workflow Package

Description

Add a sound effect to alert the user when a drake plan has either completed or returned an error.

Usage

make_with_beep(plan, .beep = TRUE, .beep_on_error = TRUE,
  lock_envir = FALSE, ...)

Arguments

plan	drake plan
.beep	logical (default = TRUE), whether to play the "ping" sound after the plan is made
.beep_on_error	logical (default = TRUE), whether to play the "facebook" sound if the plan returns an error
lock_envir	default: FALSE, whether to lock the user's environment (see help(make))
...	list, a list of parameters to pass to make()

Value

nothing

Note

lock_envir = FALSE is necessary if make_with_beep() is used on a packaged plan because expose_imports() needs to be run prior to making the plan (see the drake manual for details: https://ropenscilabs.github.io/drake-manual/best-practices.html#workflows-as-r-packages)

tiernanmartin/drakepkg documentation built on March 11, 2020, 3:11 a.m.