Skip to content

Commit 4b34845

Browse files
RStudio Connect => Posit Connect (#334)
* RStudio Connect => Posit Connect * Update R/connect_email.R --------- Co-authored-by: Neal Richardson <neal.p.richardson@gmail.com>
1 parent 8ff958a commit 4b34845

13 files changed

Lines changed: 30 additions & 30 deletions

DESCRIPTION

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Description: Compose and send out responsive HTML email messages that render
66
perfectly across a range of email clients and device sizes. Helper functions
77
let the user insert embedded images, web link buttons, and 'ggplot2' plot
88
objects into the message body. Messages can be sent through an 'SMTP'
9-
server, through the 'RStudio Connect' service, or through the 'Mailgun' API
9+
server, through the 'Posit Connect' service, or through the 'Mailgun' API
1010
service <https://www.mailgun.com/>.
1111
Authors@R: c(
1212
person("Richard", "Iannone", role = c("aut", "cre"), email = "rich@posit.co",
@@ -51,7 +51,7 @@ Suggests:
5151
withr
5252
SystemRequirements: pandoc (>= 1.12.3) - http://pandoc.org
5353
Encoding: UTF-8
54-
RoxygenNote: 7.2.3
54+
RoxygenNote: 7.3.1
5555
Roxygen: list(markdown = TRUE)
5656
Config/testthat/edition: 3
5757
Language: en-US

R/connect_email.R

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
#' Associate an email when publishing an R Markdown document to RStudio Connect
1+
#' Associate an email when publishing an R Markdown document to Posit Connect
22
#'
3-
#' This function is used to customize emails sent by RStudio Connect in
3+
#' This function is used to customize emails sent by Posit Connect in
44
#' conjunction with publishing an R Markdown document. It associates a custom
55
#' email message with the main R Markdown document, which Connect can send to
66
#' selected recipients. The main input is a rendered email message, which can be
@@ -19,7 +19,7 @@
1919
#' @param subject An option to specify the the email subject while attaching the
2020
#' email object.
2121
#' @param attachments A vector of attachments for the Connect email. These files
22-
#' can be any of those deployed when publishing to RStudio Connect, and, any
22+
#' can be any of those deployed when publishing to Posit Connect, and, any
2323
#' generated files (via R Markdown rendering).
2424
#' @param attach_output Should the rendered output of the main R Markdown
2525
#' document be included as an email attachment? By default, this is `FALSE`.
@@ -93,7 +93,7 @@ attach_connect_email <- function(
9393
}
9494
}
9595

96-
# Set the RStudio Connect output metadata options for the email message
96+
# Set the Posit Connect output metadata options for the email message
9797
# body and for the images therein
9898
rmarkdown::output_metadata$set(rsc_email_body_html = email$html_str)
9999
rmarkdown::output_metadata$set(rsc_email_images = email$images)
@@ -128,7 +128,7 @@ attach_connect_email <- function(
128128
invisible()
129129
}
130130

131-
#' Suppress any scheduled emailing in RStudio Connect
131+
#' Suppress any scheduled emailing in Posit Connect
132132
#'
133133
#' This function is useful for suppressing the scheduled emailing of a published
134134
#' R Markdown document. It can be invoked anywhere in the R Markdown document
@@ -171,7 +171,7 @@ create_rmd_preview_message <- function(subject = NULL) {
171171
paste0(
172172
"<div style=\"text-align: center; background:#fcfcfc\">",
173173
"<h2 style=\"margin-bottom: 0; padding-bottom: 0;\">",
174-
"This is an email preview for RStudio Connect</h2>",
174+
"This is an email preview for Posit Connect</h2>",
175175
"<p style=\"text-align: center; background:#fcfcfc; ",
176176
"padding-top: 0; margin-top: 0;\">",
177177
"Use <code>attach_connect_email(preview = FALSE)</code> ",

R/prepare_rsc_example_files.R

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#' Prepare example files for RStudio Connect emailing with R Markdown
1+
#' Prepare example files for Posit Connect emailing with R Markdown
22
#'
33
#' A set of example files relevant to emailing with R Markdown in RStudio
44
#' Connect can be spawned in a specified location. There is a set of three files
@@ -22,10 +22,10 @@
2222
#' The main report and associated email can be published by opening
2323
#' `"connect-example-main.Rmd"` and pressing the Publish button at the top-right
2424
#' of the Editor pane (please ensure beforehand that you are set up work with
25-
#' RStudio Connect). If asked `"What do you want to publish?"`, choose the first
25+
#' Posit Connect). If asked `"What do you want to publish?"`, choose the first
2626
#' option where only the `"connect-example-main"` document is published. All
2727
#' three files should be checked in the final dialog box, press the `Publish`
28-
#' button to publish to RStudio Connect.
28+
#' button to publish to Posit Connect.
2929
#'
3030
#' There is also the single `"connect-example-text-only.Rmd"` file that, when
3131
#' published, serves as a mechanism to send a text-only email. The content of

R/render_email.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
#' with the output specified as `output: blastula::blastula_email`. While the
66
#' `render_email()` and `render_connect_email()` functions have similar
77
#' arguments, the `render_connect_email()` is preferred when publishing to the
8-
#' RStudio Connect service. It allows for the inclusion of a predefined footer
8+
#' Posit Connect service. It allows for the inclusion of a predefined footer
99
#' that contains useful links for email recipients.
1010
#'
1111
#' @param input The input file to be rendered. This should be an R Markdown

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@ email |>
8484
)
8585
```
8686

87-
### Sending Email Messages through RStudio Connect
87+
### Sending Email Messages through Posit Connect
8888

89-
We can also send email based on **R Markdown** files through **RStudio Connect**. The `prepare_rsc_example_files()` function provides .Rmd files that facilitate a main report + email report workflow. The key components are the `blastula::blastula_email` output type for the email report, and the use of `render_connect_email()` and `attach_connect_email()` in the main report.
89+
We can also send email based on **R Markdown** files through **Posit Connect**. The `prepare_rsc_example_files()` function provides .Rmd files that facilitate a main report + email report workflow. The key components are the `blastula::blastula_email` output type for the email report, and the use of `render_connect_email()` and `attach_connect_email()` in the main report.
9090

9191
### Installation
9292

_pkgdown.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,9 @@ reference:
7474
- delete_credential_key
7575
- delete_all_credential_keys
7676

77-
- title: Email Sending through RStudio Connect
77+
- title: Email Sending through Posit Connect
7878
desc: >
79-
Using the RStudio Connect service, it's possible to publish R Markdown
79+
Using the Posit Connect service, it's possible to publish R Markdown
8080
documents and provide a scheduled email based on the report. Example
8181
.Rmd documents can be generated by using the `prepare_rsc_example_files()`
8282
function. These files constitute a working example for a publishing
@@ -105,7 +105,7 @@ navbar:
105105
menu:
106106
- text: "Custom Emails with R Markdown and Blastula"
107107
href: https://solutions.rstudio.com/r/blastula/
108-
- text: "Customized Conditional Emails with RStudio Connect"
108+
- text: "Customized Conditional Emails with Posit Connect"
109109
href: https://solutions.rstudio.com/r/blastula/conditional-example/
110110
- text: "Scheduling Data Science Tasks"
111111
href: https://solutions.rstudio.com/data-science-admin/scheduling/

inst/examples/connect-example-main.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,15 @@ It looks like the year `r dallas_home_sales %>% filter(total_sales == max(total_
5757
dallas_home_sales %>% write_csv("dallas_home_sales.csv")
5858
```
5959

60-
We can create an email on **RStudio Connect** that aligns with the content from this report. We do this with the `render_connect_email()` and `attach_connect_email()` functions from the **blastula** package. The email subdocument (`"connect-example-email.Rmd"`) is used to craft the contents of the email, drawing upon results available in this document. Attachments for the email can added by using the arguments:
60+
We can create an email on **Posit Connect** that aligns with the content from this report. We do this with the `render_connect_email()` and `attach_connect_email()` functions from the **blastula** package. The email subdocument (`"connect-example-email.Rmd"`) is used to craft the contents of the email, drawing upon results available in this document. Attachments for the email can added by using the arguments:
6161

6262
- `attachments` (for any output files or included files)
6363
- `attach_output` (which attaches the rendered report)
6464

6565
```{r connect_email_setup, echo=FALSE}
6666
render_connect_email(input = "connect-example-email.Rmd") %>%
6767
attach_connect_email(
68-
subject = "RStudio Connect HTML Email",
68+
subject = "Posit Connect HTML Email",
6969
attach_output = TRUE,
7070
attachments = c("dallas_home_sales.csv", "austin_home_sales.csv")
7171
)

inst/examples/connect-example-text-only.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ library(blastula)
1010

1111
# An R Markdown Document for Sending an Email
1212

13-
We can create a text-only email using **RStudio Connect**. Only one function is required: `attach_connect_email()`. Files can be attached using the `attachments` argument.
13+
We can create a text-only email using **Posit Connect**. Only one function is required: `attach_connect_email()`. Files can be attached using the `attachments` argument.
1414

1515
None of the content from this R Markdown file will be included in the email message body, but, if we wanted to, we could elect to attach the output file using `attach_output = TRUE`.
1616

1717
```{r connect_email, echo=FALSE}
1818
attach_connect_email(
19-
subject = "RStudio Connect Text Email",
19+
subject = "Posit Connect Text Email",
2020
attachments = "austin_home_sales.csv",
2121
text = "
2222

man/attach_connect_email.Rd

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/prepare_rsc_example_files.Rd

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)