Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eddelbuettel/rpushbullet
R interface to the awesome Pushbullet service
https://github.com/eddelbuettel/rpushbullet
json messaging pushbullet r
Last synced: about 1 month ago
JSON representation
R interface to the awesome Pushbullet service
- Host: GitHub
- URL: https://github.com/eddelbuettel/rpushbullet
- Owner: eddelbuettel
- Created: 2014-05-24T18:48:46.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-05-24T20:57:19.000Z (4 months ago)
- Last Synced: 2024-06-11T08:49:26.065Z (3 months ago)
- Topics: json, messaging, pushbullet, r
- Language: R
- Homepage: https://eddelbuettel.github.io/rpushbullet
- Size: 704 KB
- Stars: 93
- Watchers: 8
- Forks: 19
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
Awesome Lists containing this project
- jimsghstars - eddelbuettel/rpushbullet - R interface to the awesome Pushbullet service (R)
README
## RPushbullet: R interface to Pushbullet
[](https://github.com/eddelbuettel/rpushbullet/actions?query=workflow%3Aci)
[](https://www.gnu.org/licenses/gpl-2.0.html)
[](https://cran.r-project.org/package=RPushbullet)
[](https://cran.r-project.org/package=RPushbullet)
[](https://www.r-pkg.org/pkg/RPushbullet)
[](https://codecov.io/gh/eddelbuettel/rpushbullet)
[](https://github.com/eddelbuettel/rpushbullet)
[](https://eddelbuettel.github.io/rpushbullet/)
### What is this?
RPushbullet is an R client for the wonderful
[Pushbullet](https://www.pushbullet.com) messaging / notification system.
### So what is Pushbullet?
[Pushbullet](https://www.pushbullet.com) is an awesome (and free) little
service that acts as a message broker. You sign up, and get a key to use the
API. You then install the "app" on your smartphone or Chrome browser (and
obtain a device id for of these). You can also query your account with the
`pbDevices()` function to retrieve these ids.
Presto. Now you can send messages between them by invoking `pbPost()`.
### Example
With a resource file (see below) properly setup, you can just do something like the following
```r
R> msg # just an example, can be driven by real simulation results
[1] "DONE after 10000 simulations taking 42.43 minutes reducing RMSE by 7.89 percent"
R>
R> RPushbullet::pbPost("note", title="Simulation complete", body=msg)
```
and a message like the image following below should pop up (if messaging directed to the browser):
Another excellent use case was suggested years ago by [Karl Broman](https://kbroman.org/) in
[this blog post](https://kbroman.wordpress.com/2014/09/04/error-notifications-from-r/). We can
improve on his version a little as one no longer needs to load the package:
```r
options(error = function() {
RPushbullet::pbPost("note", "Error", geterrmessage())
if(!interactive()) stop(geterrmessage())
})
```
There was one noteworthy follow-up for which I lost the source: it suggested to make the message
somewhat saltier by relying on the helpful [rfoaas](https://dirk.eddelbuettel.com/code/rfoaas.html) package.
### Documentation
Package documentation, help pages, a vignette, and more is available
[here](https://eddelbuettel.github.io/rpushbullet/).
### Package Status
The package is reasonably mature and functional.
Up until release 0.2.0, an external `curl` binary was used. We have since switched to using
the [curl](https://cran.r-project.org/package=curl) package.
Given that the [Pushbullet API](https://docs.pushbullet.com/) has other nice features, future
extensions are certainly possible and encouraged. Interested contributors should file issue
tickets first to discuss before going off on pull requests.
### Initialization
A file `~/.rpushbullet.json` can be used to pass the API key and device
identifiers to the package. The content is read upon package startup, and
stored in a package-local environment. The format of this file is as follows:
```
{
"key": "...placey your api key here...",
"devices": [
".....device 1 id......",
".....device 2 id......",
".....device 3 id......"
],
"names": [
"...name1...",
"...name2...",
"...name3..."
],
"defaultdevice": "...nameOfYourDefault..."
}
```
The `names` and `defaultdevice` fields are optional. See the main package
help page for more details.
You can also create the file programmatically via
```r
cat(jsonlite::toJSON(list(key="..key here..", devices=c("..aa..", "..bb.."))))
```
and write that content to the file `~/.rpushbullet.json`.
Starting with release 0.3.0, a new helper function `pbSetup()` is also
available to create the file.
You can also retrieve the ids of your devices with the `pbGetDevices()`
function by calling, say, `str(fromJSON(pbGetDevices()))`. Note that you
need to load one of the packages `RJSONIO` or `rjson` or `jsonlite` to access
the `fromJSON()` function.
### Channels
Pushbullet has recently added [channels](https://www.pushbullet.com/channels)
to their API. These are notification feeds that user can subscribe to, and
which allows the developer to create (per-topic) channels for various
applications / topics that her users can subscribe to.
Creating a channel is easy: one simply needs to login and visit the
[My Channel](https://www.pushbullet.com/my-channel) page. From there, one
can easily create a new channel by clicking the "add channel" button. There
will be a prompt to enter a 'tag', a channel name, as well as a
description. The `channel_tag` is what is needed to push posts to the
channel. Currently, only the owner of a channel has permissions to post to
that channel, so one will need to create the channel using the same login one
has specified in `~/.rpushbullet.json` in order to use RPushbullet to post to
a channel.
_Channels are public_: Anyone who knows the channel 'tag' can subscribe and
will therefore receive all messages pushed to that channel. Some users create
hard-to-guess channel tags to achieve semi privacy. This works because it is,
currently as of February 2015, neither possible to list the channels owned by
a specific user nor possible to browse or search for other users' channels.
One method to generate a hard-to-guess tag is `digest::digest(rnorm(1))`.
Channels can be used by passing a `channel` argument to the `pbPost`
function. The Pushbullet API identifies a channel via the
supplied `channel_tag` value of this argument. See the
[Pushes API documentation](https://docs.pushbullet.com/) for more
information.
### Author
Dirk Eddelbuettel with contributions by Bill Evans, Mike Birdgeneau, Henrik
Bengtsson, Seth Wenchel, Colin Gillespie and Chan-Yub Park.
### License
GPL (>= 2)