Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tymekdev/sender
R package providing a simple interface for sending messages.
https://github.com/tymekdev/sender
gmail notifications r r-package sender sending sending-notifications slack telegram
Last synced: about 14 hours ago
JSON representation
R package providing a simple interface for sending messages.
- Host: GitHub
- URL: https://github.com/tymekdev/sender
- Owner: TymekDev
- License: other
- Created: 2019-10-07T12:00:36.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-06-26T16:48:23.000Z (over 4 years ago)
- Last Synced: 2024-08-13T07:15:12.684Z (3 months ago)
- Topics: gmail, notifications, r, r-package, sender, sending, sending-notifications, slack, telegram
- Language: R
- Homepage: https://tymekdev.github.io/sendeR/
- Size: 1.62 MB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
Awesome Lists containing this project
README
---
output: github_document
---
## sendeR 
[](https://travis-ci.com/tmakowski/sendeR)
[](https://ci.appveyor.com/project/tmakowski/sendeR)
[](https://codecov.io/gh/tmakowski/sendeR?branch=master)
[](https://www.tidyverse.org/lifecycle/#maturing)
[](https://opensource.org/licenses/MIT)
### Overview
sendeR is a package whose premise is sending messages to various messaging and/or mailing services using a simple unified interface with as little dependencies as possible.
Package originated as a project for an Advanced R course at a Faculty of Mathematics and Information Science at the Warsaw University of Technology.
### Installation
To install the development package version from GitHub repository use the following code:
```{r, eval = FALSE}
# install.packages("devtools")
devtools::install_github("tmakowski/sendeR")
```
### Supported Services
Note: services requiring OAuth2.0 require `httr` and `openssl` packages installed.
- [Gmail](https://gmail.com) **(OAuth2.0)**
- [Slack](https://slack.com)
- [Telegram](https://telegram.org/)
### Usage
1. Create a client for one of the supported services. For details on how to get access to the service's API please refer to given client's documentation.
1. Use `send_message` method on the created client.
```{r, eval = FALSE}
library("sendeR")
my_telegram_client <- client_telegram()
send_message(my_telegram_client, "Hello world!", )
```
As of version `0.9.0.9000` it is possible to set *default* parameters in the clients as shown below. As of version `0.10.3.9000` it is possible to pass `set_fields` arguments directly into client constructor, e.g. `client_telegram(, message = "Hi world!")`.
```{r, eval = FALSE}
client <- client_telegram()
client <- set_fields(client, destination = , message = "Hi world!")
# This will send "Hi world!" message to chat under .
send_message(client)
# This will send "Hello world!" message to chat under .
send_message(client, message = "Hello world!")
```
#### Additional Features
* Version `0.10.0.9000` of the package has the `sendeR_txtProgressBar` function which shares the behaviour of regular `txtProgressBar` with addition of sending a message when calculation is finished. Please refer to the documentation for usage details.
* Version `0.9.0.9000` of the package comes with the `sendeR_lapply` function which can easily be used to send notifications after a calculation is finished. Please refer to the documentation for usage details.
#### Important Remarks
- Creating `client_gmail` pauses code execution and waits for the OAuth2.0 authorization. This can be avoided in subsequent `client_gmail` calls if `httr` OAuth caching functionality is used.
- Currently passing an argument of wrong type to any function will result in a code stop due to failed assertion. Please test your sendeR calls before running long calculations.
### Cheatsheet
[PDF Version](vignettes/cheatsheet/sendeR_cheatsheet.pdf)
### How to contribute?
*Coming soon...*
### Planned Features
- `quick_send_message` - method for sending messages in one line (client creation not required). Note: only for clients not requiring OAuth.
- Searching system environment for required parameters during clients construction if they are missing.