https://github.com/coatless-rpkg/ghapi3

Work In Progress: GitHub API v3.0 implemented in R using the gh package
https://github.com/coatless-rpkg/ghapi3

github github-api r

Last synced: about 1 month ago
JSON representation

Work In Progress: GitHub API v3.0 implemented in R using the gh package

• Host: GitHub
• URL: https://github.com/coatless-rpkg/ghapi3
• Owner: coatless-rpkg
• Created: 2018-02-09T02:39:08.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2023-12-07T10:31:30.000Z (about 1 year ago)
• Last Synced: 2024-11-24T19:48:29.801Z (about 2 months ago)
• Topics: github, github-api, r
• Language: R
• Homepage: http://r-pkg.thecoatlessprofessor.com/ghapi3/
• Size: 3.78 MB
• Stars: 18
• Watchers: 2
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md

Awesome Lists containing this project

• jimsghstars - coatless-rpkg/ghapi3 - Work In Progress: GitHub API v3.0 implemented in R using the gh package (R)

README

        
---

output: github_document

---

```{r, echo = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "README-"

)

```

[![R-CMD-check](https://github.com/coatless-rpkg/ghapi3/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/coatless-rpkg/ghapi3/actions/workflows/R-CMD-check.yaml)

## ghapi3

The goal of `ghapi3` is to provide a full-featured interface to GitHub's API v3.0.

To do this, we use the [`gh`](https://github.com/r-lib/gh) _R_ package to 

access the GitHub API's methods.

### Installation

You can install `ghapi3` from github with:

```r

if(!requireNamespace("remotes", quietly = TRUE)) { install.packages("remotes") }

remotes::install_github("coatless-rpkg/ghapi3")

```

### Implementation

We have support presently for:

```{r}

#| echo: false

# Must be in the environment... 

library("ghapi3")

# Dynamically retrieve package functions

funcs = ls("package:ghapi3")

funcs = matrix(funcs, nrow = length(funcs))

colnames(funcs) = c("Implemented Functions")

knitr::kable(funcs)

# Shows parameter call

# lsf.str("package:ghapi3")

```

### License

GPL (>= 2)