view: Function 'view' in Package 'rGithubClient'

Description Usage Arguments Value See Also

Description

view allows users to quickly and easily view github repositories (or specific files within said repository) through the default web browser

Usage

1
  view(repository, repositoryPath, ...)

Arguments

repository

a githubRepo object – or the name of repository, as a character string in the form of /owner/repo, which is passed to getRepo along with optional arguments ref and refName to generate a githubRepo object

...

if repository is a character string specifying a repository, optional named arguments ref and refName to generate a githubRepo object

repositoryPath

optional argument specifying a specific file within the repository to view (must be contained in [email protected]$path)

Value

directs user to the default web browser and invisibly returns web url internally

See Also

getPermlink, getRepo, githubRepo, sourceRepoFile


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