Skip to content

Latest commit

 

History

History
55 lines (42 loc) · 2.42 KB

README.md

File metadata and controls

55 lines (42 loc) · 2.42 KB

pbjob

License: MIT Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. Travis build status

Run R scripts with Pushbullet Alerts

Installation

remotes::install_github("noamross/pbjob")

Setup

To use this package you need to use Pushbullet on your mobile device or browser and to set up the RPushbullet package. Details in that package README, but in short, do this just once:

  • Sign up for Pushbullet and install it on your devices/browsers if you haven't already.
  • Log in to https://www.pushbullet.com/#settings, click on "Create Access Token", and get the token.
  • Run RPushbullet::pbSetup(<YOUR_ACCESS_TOKEN>) to create a config file and select your default devices to send messages to.
  • Restart R

Functions

The package has six functions, each of which has an accompanying RStudio Add-In

  • source_and_pb(script_path) runs a script and sends a Pushbullet alert when it is complete. An alert is also sent if the script errors. If script_path is NULL, the RStudio interface is used to select a file.
  • bg_and_pb() runs the script in a background session with the same alerts. It returns an r_process object.
  • job_and_pb() runs the script as an RStudio Job with the same alerts. Note that the progress bar will not display anything.
  • source_current_and_pb(), bg_current_and_pb() and job_current_and_pb() do the same but run the current active file in the RStudio editor. They're especially handy if you assign the Add-Ins keyboard shortcuts.

Note that background sessions are child processes of the R session in which they are launched, and will be killed is if you quit or restart R.

Please note that the 'pbjob' project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.