Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/feddelegrand7/mailtoR
🐹🐹🐹 Creates a Friendly User Interface for Emails Sending in Shiny and RMarkdown
https://github.com/feddelegrand7/mailtoR
badge cran javascript metacran-downloads rmarkdo rmarkdown rstats shiny webdesign
Last synced: 3 months ago
JSON representation
🐹🐹🐹 Creates a Friendly User Interface for Emails Sending in Shiny and RMarkdown
- Host: GitHub
- URL: https://github.com/feddelegrand7/mailtoR
- Owner: feddelegrand7
- License: other
- Created: 2020-06-19T02:14:26.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-09T21:55:47.000Z (almost 4 years ago)
- Last Synced: 2024-07-14T09:22:45.809Z (4 months ago)
- Topics: badge, cran, javascript, metacran-downloads, rmarkdo, rmarkdown, rstats, shiny, webdesign
- Language: R
- Homepage: https://ihaddadenfodil.com/post/sending-emails-should-be-easier-in-rmarkdown/
- Size: 2.99 MB
- Stars: 22
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.Rmd
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-shiny-extensions - mailtoR - Creates a friendly user interface for emails sending in Shiny. (Backend / Notification Integration)
- jimsghstars - feddelegrand7/mailtoR - 🐹🐹🐹 Creates a Friendly User Interface for Emails Sending in Shiny and RMarkdown (R)
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# mailtoR
[](https://cran.r-project.org/package=mailtoR)
[](https://cran.r-project.org/package=mailtoR)
[](https://cran.r-project.org/package=mailtoR)
[](https://cran.r-project.org/package=mailtoR)
[](https://choosealicense.com/licenses/mit/)
[](https://travis-ci.com/feddelegrand7/mailtoR)
[](https://github.com/feddelegrand7/mailtoR)
The goal of `mailtoR` is to implement a personalized user interface for emails sending within your Shiny applications and/or RMarkdown documents. It's a wrapper of the [Mailtoui](https://mailtoui.com/#menu) JavaScript library.
## Installation
You can install the `mailtoR` package from [CRAN](https://CRAN.R-project.org/package=mailtoR) with:
```{r, eval=FALSE}
install.packages("mailtoR")
```
You can install the development version of `mailtoR` from Github with:
```{r, eval=FALSE}
# install.packages("remotes")
remotes::install_github("feddelegrand7/mailtoR")
```
## How to use the package
The `mailtoR` package is composed of two functions:
+ `use_mailtoR()`: put this function __at the end of your Shiny ui__, it activates the features of the [Mailtoui](https://mailtoui.com/#menu) library;
+ `mailtoR()`: use this function to create as many email links as you want (see examples below)
#### The following examples are provided in Shiny coding however the principles remain the same for RMarkdown documents.
## Examples:
```{r, eval=FALSE}
library(shiny)
library(mailtoR)
ui <- fluidPage(
mailtoR(email = "[email protected]",
text = "Click here to send an email !"),
use_mailtoR()
)
server <- function(input, output) {}
shinyApp(ui = ui, server = server)
```
You can use many parameters to configure your email framework:
```{r, eval=FALSE}
library(shiny)
library(mailtoR)
ui <- fluidPage(
mailtoR(email = "[email protected]",
text = "click here to send an email",
subject = "URGENT",
cc = c("[email protected]", "[email protected]"),
body = "Hi Michaels, it's David Wallace, your branch needs to make more sales !!!!!!!"),
use_mailtoR()
)
server <- function(input, output) {}
shinyApp(ui = ui, server = server)
```
Using the [glue](https://CRAN.R-project.org/package=glue) package, you can ever create a reproducible text report that you'll embed within your email:
```{r, eval=FALSE}
library(shiny)
library(mailtoR)
ui <- fluidPage(
mailtoR(email = "[email protected]",
text = "click here to send an email",
subject = "Useful Information",
body = glue::glue(
"
Hi,
Did you know that the mtcars dataset has {nrow(mtcars)} rows and {ncol(mtcars)} columns ?
Best regards.
"
)),
use_mailtoR()
)
server <- function(input, output) {}
shinyApp(ui = ui, server = server)
```
If you want to send a vector of data you'll need to use `mailtoR` in conjunction with the `jsonlite` package.
```{r, eval=FALSE}
library(shiny)
library(mailtoR)
library(jsonlite)
# converting our data to JSON format
vec <- toJSON(mtcars$mpg)
# reformat our results to make it prettier
vec_pretty <- prettify(vec)
ui <- fluidPage(
mailtoR(email = "[email protected]",
text = "click here to send an email",
subject = "Useful Information",
body = glue::glue(
"
Hi,
Below you'll find the mpg column of the mtcars data frame:
{vec_pretty}
Best regards
"
)),
use_mailtoR()
)
server <- function(input, output) {}
shinyApp(ui = ui, server = server)
```
## Code of Conduct
Please note that the mailtoR project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.