Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ColinFay/rnotify
A Wrapper Around the 'node-notify-cli' module, in R.
https://github.com/ColinFay/rnotify
Last synced: 8 days ago
JSON representation
A Wrapper Around the 'node-notify-cli' module, in R.
- Host: GitHub
- URL: https://github.com/ColinFay/rnotify
- Owner: ColinFay
- License: other
- Created: 2019-04-14T12:49:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-04-14T13:29:58.000Z (over 5 years ago)
- Last Synced: 2024-08-13T07:14:38.430Z (4 months ago)
- Language: R
- Size: 2.82 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - ColinFay/rnotify - A Wrapper Around the 'node-notify-cli' module, in R. (R)
README
---
output: github_document
---
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# rnotify
A very simple wrapper around `node-notifier CLI`, "A Node.js module for sending notifications on native Mac, Windows and Linux (or Growl as fallback)" [link](https://github.com/mikaelbr/node-notifier).
## Installation
### Node Module
__You'll need to have a working installation of the Node JS module `node-notifier-cli`__, which you can install with:
```
sudo npm i -g node-notifier-cli
```
Check that it works by running in your console:
```
notify -t "Hello" -m "My Message"
```
### R Package
```{r eval = FALSE}
remotes::install_github("ColinFay/rnotify")
```
## Run
Launch notification with:
```{r eval = FALSE}
library(rnotify)
new_notif(
"Ended",
"Come back to R now!"
)
```
Only title and message are mandatory. Other possible args are:
+ `subtitle` Subtitle of the notification (not available on windows).
+ `sound` Sound of the notification
## Returned object
The returned object from `new_notif()` is the result `processx::process$new()` and can be handled as such.
## Prior work
+ [{notifier}](https://github.com/gaborcsardi/notifier)
## CoC
Please note that the `rnotify` project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.