pins (version 0.1.1)

board_register_github: Register GitHub Board

Description

Wrapper with explicit parameters over board_register() to register a GitHub repo as a board.

Usage

board_register_github(name = "github", repo = NULL,
  branch = "master", token = NULL, path = "", cache = "~/.pins")

Arguments

name

Optional name for this board, defaults to 'github'.

repo

The GitHub repository formatted as 'owner/repo', can be NULL if the GITHUB_PAT environment variable is set.

branch

The branch to use when commiting pins.

token

Token to use when GITHUB_PAT is not specified.

path

The subdirectory in the repo where the pins will be stored.

cache

The local folder to use as a cache, defaults to "~/.pins".

See Also

board_register

Examples

# NOT RUN {
# the following example requires a GitHub API key
board_register_github(repo = "owner/repo")
# }