Skip to content

Commit

Permalink
stash work on vignette
Browse files Browse the repository at this point in the history
  • Loading branch information
tanho63 committed Dec 30, 2023
1 parent 9fee352 commit 6ff7768
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions vignettes/piggyback.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -121,18 +121,20 @@ without additional arguments to pull in any data associated with a project on a
GitHub repo that is too large to commit to git directly.

Notice that above, `iris2.tsv.gz` was not downloaded. `pb_download()` will skip
downloading of any file that already exists locally, if the timestamp on the local copy is more recent than the timestamp on the GitHub copy. Use the `overwrite` parameter to control this behaviour.
downloading of any file that already exists locally, if the timestamp on the local
copy is more recent than the timestamp on the GitHub copy. Use the `overwrite`
parameter to control this behaviour.

`pb_download()` also includes arguments to control the progress bar or if any particular
files should not be downloaded.
`pb_download()` also includes arguments to control the progress bar or if any
particular files should not be downloaded.

### Download URLs
### Public Download URLs

Sometimes it is preferable to have a URL from which the data can be read in directly,
rather than downloading the data to a local file. For example, such a URL can be
embedded directly into another R script, avoiding any dependence on `piggyback`
(provided the repository is already public.) To get a list of URLs rather than
actually downloading the files, use `pb_download_url()`:
(provided the repository is already public.) To get a list of public download URLs
rather than actually downloading the files, use `pb_download_url()`:

```r
pb_download_url(repo = "cboettig/piggyback-tests",
Expand All @@ -145,6 +147,10 @@ pb_download_url(repo = "cboettig/piggyback-tests",
[4] "https://github.com/cboettig/piggyback-tests/releases/download/v0.0.1/iris2.tsv.gz"
```

Note that these will not work if authentication is required to download them

## Reading data

## Uploading data

If your GitHub repository doesn't have any
Expand Down

0 comments on commit 6ff7768

Please sign in to comment.