https://github.com/richpauloo/textme
Send text messages from R to your cell phone 📱 to notify you when long-running jobs complete ⌛✔️.
https://github.com/richpauloo/textme
Last synced: 4 months ago
JSON representation
Send text messages from R to your cell phone 📱 to notify you when long-running jobs complete ⌛✔️.
- Host: GitHub
- URL: https://github.com/richpauloo/textme
- Owner: richpauloo
- Created: 2019-09-24T01:02:49.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-08-11T21:12:07.000Z (over 4 years ago)
- Last Synced: 2024-08-13T07:14:58.794Z (8 months ago)
- Language: R
- Homepage:
- Size: 39.1 KB
- Stars: 64
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
Awesome Lists containing this project
- jimsghstars - richpauloo/textme - Send text messages from R to your cell phone 📱 to notify you when long-running jobs complete ⌛✔️. (R)
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-"#,
#out.width = "100%"
)
```
# textme
The heart of this package is a single function called `textme()` that sends you a text message 📱 the instant a long-running job completes ⌛✔️.
Now you can leave the computer while it crunches away. Go get a cofee, hit the gym, or work on other things! You'll be notified exactly when your job completes 🎉.
## Installation
**textme** is not currently on CRAN. Install the development version from github:
```r
devtools::install_github("richpauloo/textme")
```
## Example
First, sign up for a free Twilio trial account.
1. [regular sign up](https://www.twilio.com/)
2. [my referral link](https://www.twilio.com/referral/rIaK9w), and if you decide down the line to upgrade to a paid Twilio account (I have one), you and I both get $10 in free credit (~1,250 messages).
It doesn't matter to me which road you take. Go for option 1. just to get started and to avoid ponzi-scheme vibes.
Next, [set up a project](https://support.twilio.com/hc/en-us/articles/360011177133-View-and-Create-New-Projects-in-Twilio-Console) and [verify your number](https://support.twilio.com/hc/en-us/articles/223180048-Adding-a-Verified-Phone-Number-or-Caller-ID-with-Twilio). The Twilio docs are good for this.
Then, provide information about your twilio account and the number you want to text. These variables are stored in `"~/.Renviron"` for later use. The benefit of doing it this way is that it's virtually impossible to accidentally push these credentials to Github, which is likely if you save them in scripts.
```{r setup, eval = FALSE}
library(textme)
# replace the values here with your own
tm_configure(twilio_sid = "AC1ffb4917879549a0f0720c0214bde131",
twilio_token = "f5c8904b9af81daf3e8dda09f975c369",
twilio_phone_number = "1234567890",
target_phone_number = "0987654321")
```
The above code needs to be run only once. Now, and in future R sessions, simply throw a `textme()` at the end of a long-running job (**textme** comes pre-loaded with a handful of fun messages):
```{r eval = FALSE}
Sys.sleep(5) # some long-running job
textme() # text me when it's done!
```
Or, you can supply a custom message with the `message` argument:
```{r, eval = FALSE}
textme(message = "👹 Back to work! You're not paid to run around and drink ☕ all day!")
```
## Acknowledgments
This package is inspired by [{ beepr }](https://www.r-project.org/nosvn/pandoc/beepr.html), and wouldn't be possible without the [{ twilio }](https://github.com/seankross/twilio) package from Sean Kross, [{ devtools }](https://github.com/r-lib/devtools), [{ roxygen2}](https://github.com/r-lib/roxygen2), and [RStudio](https://www.rstudio.com/).