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.

Sign up for GitHub

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

Jump to bottom

Updates to README and vignettes #112

Merged
merged 13 commits into from
Dec 29, 2023
Merged

Updates to README and vignettes #112

merged 13 commits into from
Dec 29, 2023

Conversation

tanho63
Copy link
Collaborator

@tanho63 tanho63 commented Dec 27, 2023 •
edited
Loading

This PR applies some copyediting to the documentation, specifically the README and vignettes.

  • README is more concise, and points to the getting started vignette more
  • (at least on GitHub itself) the README has a video snippet from my RStudioConf talk about piggyback
  • renamed intro.Rmd to piggyback.Rmd to take advantage of pkgdown's getting started feature.
    • Applied a bit of the copyediting from README but is mostly the same otherwise.
    • Added manual text-wrapping at approximately 80 characters to make it a little easier to work with (imo)
  • alternatives.Rmd is mostly the same
  • adds duckdb/arrow vignette (closes add vignette on how to use with arrow/duckdb for better performance #111)

To Do:

@tanho63 tanho63 requested a review from cboettig December 27, 2023 00:11
tanho63
tanho63 commented Dec 27, 2023
View reviewed changes
README.Rmd Show resolved Hide resolved
tanho63
tanho63 commented Dec 27, 2023
View reviewed changes
vignettes/duckdb_arrow.Rmd Outdated Show resolved Hide resolved
cboettig
cboettig approved these changes Dec 29, 2023
View reviewed changes
Copy link
Member

@cboettig cboettig left a comment

Choose a reason for hiding this comment

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

Looks great! Minor comments on easier syntax for duckdb to open a vector of URLs, and a comment on the auth section for the README.

README.Rmd Show resolved Hide resolved
vignettes/duckdb_arrow.Rmd Outdated Show resolved Hide resolved
vignettes/piggyback.Rmd Show resolved Hide resolved
@tanho63 tanho63 enabled auto-merge (squash) December 29, 2023 19:18
@tanho63 tanho63 merged commit 39c665b into master Dec 29, 2023
6 checks passed
@tanho63 tanho63 deleted the tan/improve-docs branch December 29, 2023 19:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cboettig cboettig cboettig approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

add vignette on how to use with arrow/duckdb for better performance
2 participants
@tanho63 @cboettig