Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ropenscilabs/allcontributors
all-contributions as an R package
https://github.com/ropenscilabs/allcontributors
Last synced: 3 months ago
JSON representation
all-contributions as an R package
- Host: GitHub
- URL: https://github.com/ropenscilabs/allcontributors
- Owner: ropenscilabs
- Created: 2020-05-26T08:55:38.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-18T09:05:31.000Z (8 months ago)
- Last Synced: 2024-05-02T02:01:15.628Z (6 months ago)
- Language: R
- Homepage: https://docs.ropensci.org/allcontributors/
- Size: 423 KB
- Stars: 22
- Watchers: 3
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.Rmd
- Codemeta: codemeta.json
Awesome Lists containing this project
- jimsghstars - ropenscilabs/allcontributors - all-contributions as an R package (R)
README
---
title: "allcontributors"
output:
rmarkdown::html_vignette:
self_contained: no
md_document:
variant: markdown_github
---
```{r setup, include=FALSE}
knitr::opts_chunk$set (
collapse = TRUE,
warning = TRUE,
message = TRUE,
width = 120,
comment = "#>",
fig.retina = 2,
fig.path = "README-"
)
```
[](https://github.com/ropenscilabs/allcontributors/actions?query=workflow%3AR-CMD-check)
[](https://app.codecov.io/gh/ropenscilabs/allcontributors)
[](https://www.repostatus.org/#active)
[](https://cran.r-project.org/web/packages/allcontributors/)
[](https://cran.r-project.org/package=allcontributors)
An alternative implementation in R of the original
[`all-contributors`](https://allcontributors.org/) to acknowledge all
contributors in your 'README' (or elsewhere). The original is intended to help
acknowledge *all* contributions including those beyond the contents of an
actual repository, such as community or other or less-tangible organisational
contributions. This version only acknowledges tangible contributions to
a repository, but automates that task to a single function call, in the hope
that such simplicity will spur greater usage. In short: This package can't do
everything the original does, but it makes what it does much easier.
## Why then?
The original [`all-contributors`](https://allcontributors.org/) is primarily
a bot which responds to commit messages such as `add @user for `,
where `` is one of the [recognized
types](https://allcontributors.org/docs/en/emoji-key). As said above, the
relative advantage of that original system lies primarily in the diversity of
contribution types able to be acknowledged, with each type for a given user
appearing as a corresponding
[emoji](https://allcontributors.org/docs/en/emoji-key) below their github
avatar as listed on the README. In comparison, this R package:
1. Works automatically, by calling `add_contributors()` at any time to add or
update contributor acknowledgements.
2. Works locally without any bot integration
3. Can add contributors to any file, not just the main README
4. Offers a variety of formats for listing contributors:
(i) divided into sections by types of contributions, or as a single section
(ii) presented as full grids (like [the
original](https://github.com/all-contributors/all-contributors/blob/master/README.md#contributors-)),
numbered lists of github user names only, or single text strings of
comma-separated names.
## Installation
The package is on CRAN, and can be installed with,
```{r cran-install, eval = FALSE}
install.packages ("allcontributors")
```
Alternatively, a development version can be installed by enabling the
"ropenscilabs" repository from
[r-universe](https://ropenscilabs.r-universe.dev):
```{r}
options (repos = c (
ropenscilabs = "https://ropenscilabs.r-universe.dev",
CRAN = "https://cloud.r-project.org"
))
```
The `install.packages()` command will then install the development version.
Alternatively, any of the following options may be used for those who prefer
not to use GitHub:
```{r gh-installation, eval = FALSE}
# install.packages("remotes")
remotes::install_git ("https://git.sr.ht/~ropenscilabs/allcontributors")
remotes::install_git ("https://codeberg.org/mpadge/allcontributors")
remotes::install_bitbucket ("mpadge/allcontributors")
remotes::install_gitlab ("mpadge/allcontributors")
remotes::install_github ("mpadge/allcontributors")
```
The package can then be loaded the usual way:
```{r load-fakey, eval = TRUE}
library (allcontributors)
```
## Usage
The primary function of the package,
[`add_contributors()`](https://docs.ropensci.org/allcontributors/reference/add_contributors.html),
adds a table of all contributors by default to the main `README.md` file (and
`README.Rmd` if that exists). Tables or lists can be added to other files by
specifying the `files` argument of that function. The appearance of the
contributors table is determined by several parameters in that function,
including:
1. `type` For the type of contributions to include (code, contributors who open
issues, contributors who discuss issues).
2. `num_sections` For whether to present contributors in 1, 2, or 3 distinct
sections, dependent upon which `type`s of contributions are to be
acknowledged.
3. `format` Determining whether contributors are presented in a grid with
associated avatars of each contributor, as in [the
original](https://github.com/all-contributors/all-contributors/blob/master/README.md#contributors-),
an enumerated list of github user names only, or a single text string of
comma-separated names.
Contribution data are obtained by querying the github API, for which a local
key should be set as an environmental variable containing the name `"GITHUB"`
(either via `Sys.setenv()`, or as an equivalent entry in a file `~/.Renviron`).
If the main `README` file(s) contains a markdown section entitled
`"Contributors"`, the
[`add_contributors()`](https://docs.ropensci.org/allcontributors/reference/add_contributors.html)
function will add a table of contributors there, otherwise it will be appended
to the end of the document(s). If you wish your contributors table to be
somewhere other than at the end of the `README` file(s), start by adding an
empty `"## Contributors` section to the file(s) and the function will insert
the table at that point.
Any time you wish to update your contributor list, simply re-run the
`add_contributors()` function. There's even an `open_issue` parameter that will
automatically open or update a github issue on your repository so that
contributors will be pinged about them being added to your list of
contributors.
The data used to construct the contributions table can also be extracted
without writing to the `README` file(s) with the function
[`get_contributors()`](https://docs.ropensci.org/allcontributors/reference/get_contributors.html):
```{r get_contributors-data, eval = TRUE, echo = FALSE}
dat <- data.frame (
logins = c ("mpadge", "maelle", "shamindras", "assignUser"),
contributions = c (176L, rep (NA_integer_, 3L)),
avatar = c (
"https://avatars.githubusercontent.com/u/6697851?v=4",
"https://avatars.githubusercontent.com/u/8360597?u=824f03caa87c92420352e3dd9a05470320a67412&v=4",
"https://avatars.githubusercontent.com/u/7627188?u=d05fb551796e6ce6db64ae43cd8ce48a0217ef85&v=4",
"https://avatars.githubusercontent.com/u/16141871?u=bbf2ca4641e8ec034a9cdb583e62e3a94c372824&v=4"
),
type = c ("code", rep ("issue_authors", 3L))
)
```
```{r get_contributors-fakey, eval = FALSE}
get_contributors (org = "ropenscilabs", repo = "allcontributors")
```
```{r get_contributors-output, eval = TRUE, echo = FALSE}
cat (cli::col_green (cli::symbol$tick), " Extracted code contributors\n")
cat (cli::col_green (cli::symbol$tick), " Extracted github issue contributors\n")
cat (cli::col_green (cli::symbol$tick), " Downloaded GitHub URLs\n")
print (dat)
```
## Updating Contributor Acknowledgements
"Contributors" sections of files will be automatically updated to reflect any new
contributions by simply calling
[`add_contributors()`](https://docs.ropensci.org/allcontributors/reference/add_contributors.html).
If your contributors have not changed then your lists of acknowledgements will
not be changed. The
[`add_contributors()`](https://docs.ropensci.org/allcontributors/reference/add_contributors.html)
function has an additional parameter which may be set to `force_update = TRUE`
to force lists to be updated regardless of whether contributions have changed.
This can be used to change the formats of acknowledgements at any time. If
anything goes wrong, the easiest way to replace a contributions section is to
simply delete the old ones from all files, and call
[`add_contributors()`](https://docs.ropensci.org/allcontributors/reference/add_contributors.html)
again.
## More Information
The package has a [single
vignette](https://docs.ropensci.org/allcontributors/articles/allcontributors.html)
which visually demonstrates the various formats in which an "allcontributors"
section can be presented.
## Code of Conduct
Please note that this package is released with a [Contributor Code of
Conduct](https://ropensci.org/code-of-conduct/). By contributing to this
project, you agree to abide by its terms.
## Contributors
All contributions to this project are gratefully acknowledged using the [`allcontributors` package](https://github.com/ropenscilabs/allcontributors) following the [all-contributors](https://allcontributors.org) specification. Contributions of any kind are welcome!
### Code
### Issues
