In ramnathv/gh3: Access Github API V3

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

gh3

The goal of gh3 is to provide easy acccess to the Github API V3. The entire API is accessible via R functions that autocomplete.

Installation

You can install the development version of gh3 from github with:

remotes::install_github('ramnathv/gh3')

Example

You can get a list of all repos belonging to a user:

library(gh3)
gh_users_get_repos('ramnathv')

Implementation

The entire package including all functions and documentation are automatically generated from an unofficial swagger specification of the Github API. If you are curious, you can read the script generating the package: data_raw/generate_package.R

TODOs

• [ ] Revisit naming conventions for functions.
• [ ] Add @family and @seealso based on base path.
• [ ] Handle 3 cases where function name is duplicated.
• [ ] Set argument defaults based on swagger spec.
• [ ] Add documentation on additional parameters.

Code of Conduct

Please note that the gh3 project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

ramnathv/gh3 documentation built on May 7, 2019, 12:53 a.m.