pb_upload: Upload data to an existing release
In piggyback: Managing Larger Data on a GitHub Repository

pb_upload

R Documentation

Upload data to an existing release

Description

NOTE: you must first create a release if one does not already exists.

Usage

pb_upload(
  file,
  repo = guess_repo(),
  tag = "latest",
  name = NULL,
  overwrite = "use_timestamps",
  use_timestamps = NULL,
  show_progress = getOption("piggyback.verbose", default = interactive()),
  .token = gh::gh_token(),
  dir = NULL
)

Arguments

`file`	path to file to be uploaded
`repo`	Repository name in format "owner/repo". Defaults to `guess_repo()`.
`tag`	tag for the GitHub release to which this data should be attached.
`name`	name for uploaded file. If not provided will use the basename of `file` (i.e. filename without directory)
`overwrite`	overwrite any existing file with the same name already attached to the on release? Default behavior is based on timestamps, only overwriting those files which are older.
`use_timestamps`	DEPRECATED.
`show_progress`	logical, show a progress bar be shown for uploading? Defaults to `⁠[interactive()]⁠` - can also set globally with options("piggyback.verbose")
`.token`	GitHub authentication token, see `⁠[gh::gh_token()]⁠`
`dir`	directory relative to which file names should be based, defaults to NULL for current working directory.

Examples

## Not run: 
# Needs your real token to run

readr::write_tsv(mtcars,"mtcars.tsv.xz")
pb_upload("mtcars.tsv.xz", "cboettig/piggyback-tests")

## End(Not run)

piggyback documentation built on July 26, 2023, 5:31 p.m.