remote_get_api: API Query to Remote Source Control Repositories

Description Usage Arguments Value

Description

API Query to Remote Source Control Repositories

Usage

1
2
remote_get_api(remote, url, path, user = remote$auth_user,
  password = remote$auth_token, ..., config = NULL, error = FALSE)

Arguments

remote

a repository specification or remote object.

url

base API url to use.

path

path to the file to downlad, relatively to the root of the repository.

user, password

repository authetication credentials. The default is to use the user define in the remote specification 'auth_user' and 'auth_token' respectively, which can be determined transparently with remote_auth, via the credentials stored in a .netrc file.

...

other arguments passed to httr::GET

error

logical that indicates if an error should be thrown if the request is unsuccessful

Value

the request result object returned by httr::GET


renozao/repotools documentation built on May 27, 2019, 5:53 a.m.