getRepo-methods: Methods for Function 'getRepo' in Package 'rGithubClient'

In brian-bot/rGithubClient: R Github Client

Description

getRepo talks to the github API to retrieve information about a specified repository at a specific point in time (commit). There are three separate ways to convey the github commit:

(1) ref = "branch"

Must specify refName to be the name of the branch that info is to be pulled from. getRepo will find the commit that the ref and refName refer to.

(2) ref = "tag"

Must specify refName to be the name of the tag that info is to be pulled from. getRepo will find the commit that the ref and refName refer to.

(3) ref = "commit"

Must specify refName to be the sha of the commit that info is to be pulled from.

Methods

signature(repository = "character", ...)

repository

name of repository, in the form of /owner/repo

...

ref = "branch"

one of "branch", "tag", or "commit" – refName must be specified along with ref

refName = "master"

specified along with ref: name of the branch, tag, or the sha of the requested commit

Value

return value is of class githubRepo

See Also

getPermlink, githubRepo, sourceRepoFile, view

brian-bot/rGithubClient documentation built on May 13, 2019, 5:12 a.m.