README.md

In rostools/githubr: Interface to GitHub from R

githubr: An R Interface to GitHub

The goal of githubr is to simplify using GitHub’s API. Uses the wonderful gh R package. Inspiration also comes from the gitlabr package.

Installation

You can install the development version of githubr with:

# install.packages("remotes")
remotes::install_github("lwjohnst86/githubr")

Examples

Currently, most of the functionality revolves around Issues. For example, to list issues or labels:

library(githubr)

# See issues
gh_list_issues("lwjohnst86/carpenter")
#> # A tibble: 14 x 11
#>    state number title body  labels.name milestone.number milestone.title
#>    <chr> <chr>  <chr> <chr> <chr>       <chr>            <chr>          
#>  1 open  26     Inte… "htt… <NA>        <NA>             <NA>           
#>  2 open  25     Remo… ""    question    <NA>             <NA>           
#>  3 open  24     Add … ""    docs        1                v0.3.0         
#>  4 open  23     Add … "To … docs        1                v0.3.0         
#>  5 open  21     Crea… ""    feature     1                v0.3.0         
#>  6 open  20     Func… "For… feature     1                v0.3.0         
#>  7 open  19     Add … ""    feature     1                v0.3.0         
#>  8 open  17     Add … ""    feature     1                v0.3.0         
#>  9 open  16     Use … ""    feature     <NA>             <NA>           
#> 10 open  15     Have… "Ins… feature     1                v0.3.0         
#> 11 open  14     Chan… "Thi… feature     1                v0.3.0         
#> 12 open  9      Use … "Sim… feature     1                v0.3.0         
#> 13 open  2      Add … ""    <NA>        <NA>             <NA>           
#> 14 open  1      Add … ""    <NA>        <NA>             <NA>           
#> # … with 4 more variables: milestone.open_issues <chr>,
#> #   milestone.closed_issues <chr>, milestone.state <chr>, comments <chr>

# See labels.
gh_list_labels("lwjohnst86/githubr")
#> # A tibble: 8 x 2
#>   name             color 
#>   <chr>            <chr> 
#> 1 bug              d73a4a
#> 2 duplicate        cfd3d7
#> 3 enhancement      a2eeef
#> 4 good first issue 7057ff
#> 5 help wanted      008672
#> 6 invalid          e4e669
#> 7 question         d876e3
#> 8 wontfix          ffffff

Contributing

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

rostools/githubr documentation built on Aug. 17, 2020, 6:49 p.m.