Skip to content

Commit

Permalink
readme mentioning cloud native vignette
Browse files Browse the repository at this point in the history
  • Loading branch information
tanho63 committed Dec 29, 2023
1 parent 971c12b commit b2f44ff
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
4 changes: 4 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -282,5 +282,5 @@
},
"SystemRequirements": null
},
"fileSize": "578.62KB"
"fileSize": "380.757KB"
}

0 comments on commit b2f44ff

Please sign in to comment.