Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ropensci-archive/ghrecipes
:no_entry: ARCHIVED :no_entry: Provides some helper functions for using the GitHub V4 API
https://github.com/ropensci-archive/ghrecipes
ghql github-api graphql jq r r-package ropensci rstats
Last synced: about 1 month ago
JSON representation
:no_entry: ARCHIVED :no_entry: Provides some helper functions for using the GitHub V4 API
- Host: GitHub
- URL: https://github.com/ropensci-archive/ghrecipes
- Owner: ropensci-archive
- License: other
- Archived: true
- Created: 2018-02-15T12:58:27.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-05-10T14:07:32.000Z (over 2 years ago)
- Last Synced: 2024-08-13T07:14:19.843Z (5 months ago)
- Topics: ghql, github-api, graphql, jq, r, r-package, ropensci, rstats
- Language: R
- Homepage: https://docs.ropensci.org/ghrecipes
- Size: 78.1 KB
- Stars: 29
- Watchers: 5
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README-NOT.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codemeta: codemeta.json
Awesome Lists containing this project
- jimsghstars - ropensci-archive/ghrecipes - :no_entry: ARCHIVED :no_entry: Provides some helper functions for using the GitHub V4 API (R)
README
[](https://www.repostatus.org/#abandoned)
[](https://travis-ci.org/ropenscilabs/ghrecipes)
[](https://codecov.io/github/ropenscilabs/ghrecipes?branch=master)
# ghrecipes
The goal of ghrecipes is to provide helper functions for usual GitHub
*data mining* tasks, well at least the ones that are usual or useful for
us. :smile\_cat: Please suggest and discuss new recipes in [the issues
tracker\!](https://github.com/ropenscilabs/ghrecipes/issues)
It uses[GitHub V4 API](https://developer.github.com/v4/) queried thanks
to the [`ghql` package](https://github.com/ropensci/ghql). Read more
about [GitHub V4 API advantages
here](https://developer.github.com/v4/#why-is-github-using-graphql). It
then formats results using the [`jqr`
package](https://github.com/ropensci/jqr), interface to
[jq](https://stedolan.github.io/jq/). Read an intro to `jqr` power
[here](http://www.carlboettiger.info/2017/12/11/data-rectangling-with-jq/).
:rocket:
## Installation
You can install ghrecipes from GitHub with:
``` r
# install.packages("devtools")
devtools::install_github("ropenscilabs/ghrecipes")
```
## Tokens
To access GitHub, `ghrecipes` looks for tokens stored in the system
environment in the following order of precedence:
1. GITHUB\_GRAPHQL\_TOKEN
2. GITHUB\_TOKEN
3. GITHUB\_PAT
Most functions require only the `repo` scope. However, `get_teams()`
requires either `read:org` or `read:discussion` scopes, and
`get_collaborators()` requires push access to the repository of
interest.
For step-by-step guidance on getting and storing a GitHub token, refer
to the
[instructions](https://usethis.r-lib.org/articles/articles/usethis-setup.html#get-and-store-a-github-personal-access-token)
in the `usethis` package.
## Examples
Don’t miss conversations by your favorite developers or comments by your
favorite [styling bot](https://github.com/lintr-bot). In that function,
only the latest results are returned, and an issue can be a PR.
``` r
ghrecipes::spy("lintr-bot", type = "Issue")
#> NULL
convos <- ghrecipes::spy("lintr-bot", type = "PullRequest")
knitr::kable(convos[1:10,])
```
| owner | repo | title | created\_at | state | author | url | no\_comments | id |
| :---------------- | :----------- | :---------------------------- | :------------------ | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------- | -----------: | --: |
| PredictiveEcology | SpaDES.tools | move RandomFields to Suggests | 2018-09-18 23:04:49 | MERGED | achubaty | https://github.com/PredictiveEcology/SpaDES.tools/pull/50 | 1 | 50 |
| PredictiveEcology | SpaDES.tools | rasterizeReduced uses crs | 2018-09-04 20:40:18 | MERGED | achubaty | https://github.com/PredictiveEcology/SpaDES.tools/pull/49 | 1 | 49 |
| bokeh | rbokeh | Update to 0.12.5 | 2017-06-07 20:11:51 | OPEN | hafen | https://github.com/bokeh/rbokeh/pull/217 | 7 | 217 |
| NA | NA | NA | NA | NA | NA | NA | NA | NA |
| NA | NA | NA | NA | NA | NA | NA | NA | NA |
| NA | NA | NA | NA | NA | NA | NA | NA | NA |
| NA | NA | NA | NA | NA | NA | NA | NA | NA |
| NA | NA | NA | NA | NA | NA | NA | NA | NA |
| NA | NA | NA | NA | NA | NA | NA | NA | NA |
| NA | NA | NA | NA | NA | NA | NA | NA | NA |
## Use cases in the wild
- [“hrbrpkgs: list Bob Rudis’
packages”](http://www.masalmon.eu/2018/03/04/hrbrpkgs/) by [Maëlle
Salmon](https://github.com/maelle/).
- [“Lintr Bot, lintr’s Hester
egg”](http://www.masalmon.eu/2018/03/30/lintr-bot/) by [Maëlle
Salmon](https://github.com/maelle/).
- [“Rectangling
onboarding”](https://ropensci.org/blog/2018/04/26/rectangling-onboarding/)
by [Maëlle Salmon](https://github.com/maelle/).
Add your use case to the list by [opening an
issue](https://github.com/ropenscilabs/ghrecipes/issues/new) \!
## Nice words
Both the package actual use and its source code have been very useful to
me in understanding graphQL and the Github API. Thanks
@ma\_salmon\!
https://t.co/i8KUAMGfsn
— Christian Minich (@ChristianNolan)
29
d’abril de 2018
## Meta
Please note that this project is released with a [Contributor Code of
Conduct](CODE_OF_CONDUCT.md).
By participating in this project you agree to abide by its terms.