From b2f44ff4b93998f30a9701b71d2418a569d9fdfd Mon Sep 17 00:00:00 2001 From: Tan Date: Fri, 29 Dec 2023 14:01:31 -0500 Subject: [PATCH] readme mentioning cloud native vignette --- README.Rmd | 4 ++++ README.md | 11 +++++++++-- codemeta.json | 2 +- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/README.Rmd b/README.Rmd index ce6fc8a..d9dce35 100644 --- a/README.Rmd +++ b/README.Rmd @@ -85,6 +85,10 @@ pb_upload("mtcars.tsv.gz", repo = "cboettig/piggyback-tests") #> |===================================================| 100% ``` +For improved performance, we can also use piggyback files with +[cloud native](https://docs.ropensci.org/piggyback/articles/cloud_native.html) +workflows to query data without downloading it first. + ## Motivations A brief video overview presented as part of Tan Ho's [RStudioConf2022 talk](https://www.youtube.com/watch?v=wzcz4xNGeTI&t=655s): diff --git a/README.md b/README.md index b23f13e..b7ccec5 100644 --- a/README.md +++ b/README.md @@ -65,8 +65,11 @@ fs::dir_tree(tempdir()) ``` Downloading from private repos or uploading to any repo requires -authentication, specifically a \[gh::gh_token()\] or a GITHUB_PAT -environment variable - for more information, see the vignette notes on +authentication, specifically a GitHub Personal Access Token (PAT). This +can be stored as a +[gh::gh_token()](https://usethis.r-lib.org/articles/git-credentials.html#get-a-personal-access-token-pat) +or a GITHUB_PAT environment variable - for more information, see the +vignette notes on [authentication](https://docs.ropensci.org/piggyback/articles/piggyback.html#authentication). We can also upload data to a release. Start by creating a release: @@ -86,6 +89,10 @@ pb_upload("mtcars.tsv.gz", repo = "cboettig/piggyback-tests") #> |===================================================| 100% ``` +For improved performance, we can also use piggyback files with [cloud +native](https://docs.ropensci.org/piggyback/articles/cloud_native.html) +workflows to query data without downloading it first. + ## Motivations A brief video overview presented as part of Tan Ho’s [RStudioConf2022 diff --git a/codemeta.json b/codemeta.json index b08c1d9..af1aeb7 100644 --- a/codemeta.json +++ b/codemeta.json @@ -282,5 +282,5 @@ }, "SystemRequirements": null }, - "fileSize": "578.62KB" + "fileSize": "380.757KB" }