Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Polish README and introduction to glue #337

Merged
merged 8 commits into from
Aug 28, 2024
Merged

Conversation

jennybc
Copy link
Member

@jennybc jennybc commented Aug 27, 2024

Thanks to the cumulative work of 2 tidy dev days, glue has gotten a "get started" style vignette. This PR is me continuing to polish the README and that vignette.

README.Rmd Show resolved Hide resolved
README.Rmd Show resolved Hide resolved
README.Rmd Show resolved Hide resolved

`glue_data()` is very natural to use with the pipe:

```{r, eval = getRversion() >= "4.1.0"}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do need to keep this from executing on older versions of R.

The data-masking feature of `mutate()` means the columns of the target data frame are "in scope" for a `glue()` call:

```r
library(dplyr)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has to be a fixed chunk, given the use of dplyr, which is a drag. But I want to show this.

glue_sql()\` makes constructing SQL statements safe and easy Use
backticks to quote identifiers, normal strings and numbers are quoted
appropriately for your backend.
glue has explicit support for constructing SQL statements.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really haven't touched this section personally.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It almost feels like this whole section should be moved to a new SQL-focused vignette.

@jennybc jennybc requested a review from hadley August 27, 2024 15:08
README.Rmd Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
README.Rmd Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
vignettes/glue.Rmd Outdated Show resolved Hide resolved
vignettes/glue.Rmd Show resolved Hide resolved
@jennybc jennybc merged commit 793a2f3 into main Aug 28, 2024
13 checks passed
@jennybc jennybc deleted the polish-README-and-Get-started branch August 28, 2024 20:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants