release: Release data to a datastorr repository

Description Usage Arguments

View source: R/simple.R

Description

Create a relase for a simple datastorr (i.e., non-package based).

Usage

1
2
3
4
release(repo, version, description = NULL, filename = NULL,
  path = NULL, metadata = "datastorr.json", branch = "master",
  private = FALSE, refetch = FALSE, target = NULL,
  ignore_dirty = FALSE, yes = !interactive())

Arguments

repo

Either a github repo in the form <username>/<repo> (e.g., "richfitz/data" or the path to a json file on your filesystem.

version

A version number for the new version. Should be of the form x.y.z, and may or may not contain a leading "v" (one will be added in any case).

description

Optional text description for the release. If this is omitted then GitHub will display the commit message from the commit that the release points at.

filename

Filename to upload; optional if in datastorr.json. If listed, filename can be different but the file will be renamed on uploading. If given but not in info, the uploaded file will be basename(filename) (i.e., the directory will be stripped).

path

The path to store the data at. Using NULL will

metadata

The name of the metadata file within the repo (if repo refers to a github repo. The default is datastorr.json at the root of the repository, but any other filename can be used.

branch

The branch in the repo to use. Default is master.

private

A logical indicating if the repository is private and therefor if authentication will be needed to access it.

refetch

Refetch the metadata file even if it has already been downloaded previously.

target

The SHA or tag to attach the release to. By default, will use the current HEAD, which is typically what you want to do.

ignore_dirty

Ignore non-checked in files? By default, your repository is expected to be in a clean state, though files not known to git are ignored (as are files that are ignored by git). But you must have no uncommited changes or staged but uncommited files.

yes

Skip the confirmation prompt? Only prompts if interactive.


richfitz/dataverse documentation built on July 9, 2021, 12:08 p.m.