githubRepo-class: Class '"githubRepo"'

In brian-bot/rGithubClient: R Github Client

Description

Class holding information about a specific timepoint of a github repository.

Objects from the Class

Objects are generated by calling the getRepo function.

Slots

user:

Object of class "character" specifying the user account that the repository is stored in

repo:

Object of class "character" specifying the name of the repository

ref:

Object of class "character" along with refName: the type of reference that the repository is trying to capture: one of "branch", "tag", or "commit"

refName:

Object of class "character" along with ref: the name of the branch, tag, or the sha of the requested commit

commit:

Object of class "character" specifying the timepoint at which information on the repository was obtained

tree:

Object of class "data.frame" referring to the tree structure present in the repository with columns path, sha, and url

apiResponses:

Object of class "list" enumerating the GitHub API responses that were retrieved to build the object (used internally)

Methods

sourceRepoFile

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

view

signature(repository = "githubRepo", repositoryPath = "character")

See Also

getPermlink, getRepo, sourceRepoFile, view

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