githubRestGET: Interface for accessing GitHub REST API

In brian-bot/githubr: R Github Client

Description

This function allows users to access (GET) content from the GitHub API in a flexible way. The githubr package provides convenience methods to access certain types of content - this function is provided to allow users to access any other API that they choose.

Usage

  githubRestGET(uri, endpoint = .getGithubCache("githubEndpoint"), 
                .opts = .getGithubCache("opts"), 
                httpheader = .getGithubCache("httpheader"), ...)

Arguments

uri	uri of the API request, e.g. "/repos/brian-bot/githubr"
endpoint	endpoint to access uri from, e.g. "https://api.github.com/"
.opts	additional options to be passed on to getURL
httpheader	httpheader to be passed onto getURL
...	other named parameters to be passed onto getURL

Details

Defaults to recieving content in JSON format (Accept="application/json") which is, in turn, converted into a list via the rjson function fromJSON. If authorization is set via setGithubToken, the token specific to the githubr is used for subsequent calls to the API via this function.

Value

Typically a list which is the content returned from the GitHub API and converted via fromJSON.

See Also

getPermlink, githubRepo, getRepo, sourceRepoFile, view

brian-bot/githubr documentation built on June 21, 2021, 3:55 p.m.