Skip to content

Commit

Permalink
Fix badges
Browse files Browse the repository at this point in the history
  • Loading branch information
andrie committed Mar 31, 2024
1 parent 6c65d68 commit dc33da4
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 21 deletions.
6 changes: 3 additions & 3 deletions CRAN-SUBMISSION
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Version: 0.2.4
Date: 2022-03-07 16:17:04 UTC
SHA: 197fb18080d57d84ee78a92eb57cb3c0f86bb9be
Version: 0.2.5
Date: 2022-08-14 20:16:15 UTC
SHA: 6c65d68e1f787e27823e2010bf26b4cb84740ad9
9 changes: 6 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
output: github_document
format: gfm
default-image-extension: ""
---

<!-- README.md is generated from README.Rmd. Please edit that file -->
Expand All @@ -18,10 +20,11 @@ knitr::opts_chunk$set(
# mailmerge <img src='man/figures/logo.png' align="right" height="139" />

<!-- badges: start -->
[![R-CMD-check](https://github.com/andrie/mailmerge/workflows/R-CMD-check/badge.svg)](https://github.com/andrie/mailmerge/actions)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![Codecov test coverage](https://codecov.io/gh/andrie/mailmerge/branch/main/graph/badge.svg)](https://app.codecov.io/gh/andrie/mailmerge?branch=main)
[![CRAN status](https://www.r-pkg.org/badges/version/mailmerge)](https://CRAN.R-project.org/package=mailmerge)
[![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/mailmerge)](https://www.r-pkg.org/package=miniCRAN)
[![R-CMD-check](https://github.com/andrie/mailmerge/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/andrie/mailmerge/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/andrie/mailmerge/branch/main/graph/badge.svg)](https://app.codecov.io/gh/andrie/mailmerge?branch=main)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
<!-- badges: end -->


Expand Down
36 changes: 21 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,32 @@


<!-- README.md is generated from README.Rmd. Please edit that file -->

# mailmerge <img src='man/figures/logo.png' align="right" height="139" />

<!-- badges: start -->

[![R-CMD-check](https://github.com/andrie/mailmerge/workflows/R-CMD-check/badge.svg)](https://github.com/andrie/mailmerge/actions)
[![Lifecycle:
experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![Codecov test
coverage](https://codecov.io/gh/andrie/mailmerge/branch/main/graph/badge.svg)](https://app.codecov.io/gh/andrie/mailmerge?branch=main)
[![CRAN
status](https://www.r-pkg.org/badges/version/mailmerge)](https://CRAN.R-project.org/package=mailmerge)
[![CRAN RStudio mirror
downloads](https://cranlogs.r-pkg.org/badges/mailmerge)](https://www.r-pkg.org/package=miniCRAN)
[![R-CMD-check](https://github.com/andrie/mailmerge/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/andrie/mailmerge/actions/workflows/R-CMD-check.yaml)
[![Codecov test
coverage](https://codecov.io/gh/andrie/mailmerge/branch/main/graph/badge.svg)](https://app.codecov.io/gh/andrie/mailmerge?branch=main)
[![Lifecycle:
experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
<!-- badges: end -->

Mail merge from R using markdown documents and gmail.

- Parse markdown documents as the body of email
- Use the `yaml` header to specify the subject line of the email
- Use `glue` to replace `{}` tags
- Preview the email in the RStudio viewer pane
- Send email (or saving as draft) using `gmailr`
- Parse markdown documents as the body of email
- Use the `yaml` header to specify the subject line of the email
- Use `glue` to replace `{}` tags
- Preview the email in the RStudio viewer pane
- Send email (or saving as draft) using `gmailr`

Note: Right now, the only supported email back end is `gmailr` (see
<https://gmailr.r-lib.org/>).
https://gmailr.r-lib.org/).

## Installation

Expand All @@ -33,7 +36,7 @@ Install the package from CRAN:
install.packages("mailmerge")
```

Install the dev version from <https://github.com/andrie/mailmerge>
Install the dev version from https://github.com/andrie/mailmerge

``` r
remotes::install_github("andrie/mailmerge")
Expand All @@ -42,7 +45,7 @@ remotes::install_github("andrie/mailmerge")
## Setup

At the moment only gmail is supported as the email back-end, using the
`gmailr` package (<https://github.com/r-lib/gmailr>).
`gmailr` package (https://github.com/r-lib/gmailr).

Before you use `mail_merge()` it’s important to authenticate against the
gmail service, and you should use `gmailr::gm_auth()` to do this.
Expand All @@ -65,7 +68,7 @@ Write the text of your email as a R markdown document. You can add the
subject line in the yaml header. Use `{}` braces inside the email to
refer to the data inside your data frame. Expressions inside these
braces will be encoded by the `glue::glue_data()` function (See
<https://glue.tidyverse.org/>).
https://glue.tidyverse.org/).

``` r
msg <- '
Expand All @@ -92,6 +95,7 @@ To send the message, use `send = "draft"` (to save in your gmail drafts
folder) or `send = "immediately"` to send the mail immediately.

``` r

library(mailmerge)
library(gmailr, quietly = TRUE, warn.conflicts = FALSE)

Expand All @@ -115,5 +119,7 @@ if (interactive()) {
```

<center>
<img src="man/figures/mail-merge.gif" width="80%" />

<img src="man/figures/mail-merge.gif" style="width:80.0%" />

</center>

0 comments on commit dc33da4

Please sign in to comment.