GitHub API R GitHub
Need help with gh?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.
r-lib

Description

Minimalistic GitHub API client in R

142 Stars 36 Forks Other 254 Commits 15 Opened issues

Services available

Need anything else?

gh

R-CMD-check Codecov test
coverage CRAN RStudio mirror
downloads <!-- badges: end -->

Minimalistic client to access GitHub’s REST and GraphQL APIs.

Installation

Install the package from CRAN as usual:

install.packages("gh")

Usage

library(gh)

Use the

gh()
function to access all API endpoints. The endpoints are listed in the documentation.

The first argument of

gh()
is the endpoint. You can just copy and paste the API endpoints from the documentation. Note that the leading slash must be included as well.

From https://docs.github.com/rest/reference/repos#list-repositories-for-a-user you can copy and paste

GET /users/{username}/repos
into your
gh()
call. E.g.
my_repos   [1] "alexr"        "altlist"      "argufy"       "disposables"  "dotenv"      
#>  [6] "falsy"        "franc"        "ISA"          "keypress"     "lpSolve"     
#> [11] "macBriain"    "maxygen"      "MISO"         "msgtools"     "notifier"    
#> [16] "oskeyring"    "parr"         "parsedate"    "prompt"       "r-font"      
#> [21] "r-source"     "rcorpora"     "roxygenlabs"  "sankey"       "secret"      
#> [26] "spark"        "standalones"  "svg-term"     "tamper"       "testthatlabs"

The JSON result sent by the API is converted to an R object.

Parameters can be passed as extra arguments. E.g.

my_repos   [1] "oskeyring"    "testthatlabs" "lpSolve"      "roxygenlabs"  "standalones" 
#>  [6] "altlist"      "svg-term"     "franc"        "sankey"       "r-source"    
#> [11] "secret"       "msgtools"     "notifier"     "prompt"       "parr"        
#> [16] "tamper"       "alexr"        "argufy"       "maxygen"      "keypress"    
#> [21] "macBriain"    "MISO"         "rcorpora"     "disposables"  "spark"       
#> [26] "dotenv"       "parsedate"    "r-font"       "falsy"        "ISA"

POST, PATCH, PUT and DELETE requests

POST, PATCH, PUT, and DELETE requests can be sent by including the HTTP verb before the endpoint, in the first argument. E.g. to create a repository:

new_repo 

and then delete it:

gh("DELETE /repos/{owner}/{repo}", owner = "gaborcsardi",
   repo = "my-new-repo-for-gh-testing")

Tokens

By default the

GITHUB_PAT
environment variable is used. Alternatively, one can set the
.token
argument of
gh()
.

Pagination

Supply the

page
parameter to get subsequent pages:
my_repos2   [1] "rcmdcheck"   "vdiffr"      "callr"       "mockery"     "here"       
#>  [6] "revdepcheck" "processx"    "vctrs"       "debugme"     "usethis"    
#> [11] "rlang"       "pkgload"     "httrmock"    "pkgbuild"    "prettycode" 
#> [16] "roxygen2md"  "pkgapi"      "zeallot"     "liteq"       "keyring"    
#> [21] "sloop"       "styler"      "ansistrings" "later"       "crancache"  
#> [26] "zip"         "osname"      "sessioninfo" "available"   "cli"

Environment Variables

  • The
    GITHUB_API_URL
    environment variable is used for the default github api url.
  • One of
    GITHUB_PAT
    or
    GITHUB_TOKEN
    environment variables is used, in this order, as default token.

License

MIT © Gábor Csárdi, Jennifer Bryan, Hadley Wickham

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.