contribution

A Tiny Contribution Table Generator Based on ggplot2 https://shixiangwang.shinyapps.io/contribution

https://github.com/openbiox/contribution

Keywords

Repository

A Tiny Contribution Table Generator Based on ggplot2 https://shixiangwang.shinyapps.io/contribution

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```
# contribution - A Tiny Contribution Table Generator Based on ggplot2


[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/ShixiangWang/contribution?branch=master&svg=true)](https://ci.appveyor.com/project/ShixiangWang/contribution)
[![Travis build status](https://travis-ci.org/openbiox/contribution.svg?branch=master)](https://travis-ci.org/openbiox/contribution)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![CRAN status](https://www.r-pkg.org/badges/version/contribution)](https://cran.r-project.org/package=contribution)
[![](https://cranlogs.r-pkg.org/badges/grand-total/contribution?color=green)](https://cran.r-project.org/package=contribution)


The goal of **contribution** is to generate **contribution table** for credit assignment in a project. 
This is inspired by Nick Steinmetz (see twitter ). 

> Authors contributions sections are new and still don’t appear in major journals, but can be improved. Rather than text listing each author’s contributions, the same data can be presented as a table with rows corresponding to contributions and columns for each author.
>
> Advantages include: 
>
> 1. Graphics are faster and easier to comprehend. They are also easier to locate in the document.
>
> 2. This format can be readily augmented with additional information, such as distinguishing between ‘major’ and ‘minor’ contributions of each type.
>
> 3. This format can be read as easily in either direction, answering both "Who did X?" and "What did person Y do?" equally. 
>
> 4. This format lends itself to a nice extension for including your author contribution information on your CV: a similar table where each column is one of your papers.
>
>
> A difficulty with this is the diversity of terminology used, which would be helped by refinement and more widespread adoption of the CRediT framework (). 

## Feature

* Support table type
  * 3-level contribution (i.e. 'None', 'Minor' and 'Major')
  * numeric contribution
* Dataset `palette` contains 27 color maps

An R Shiny application can be found at `https://shiny.hiplot.com.cn/contribution-table/`.
Corresponding source code is available at .


## Installation

You can install the released version of contribution from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("contribution")
```

And the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("openbiox/contribution")
```

## Basic example

This is a basic example which shows you how to plot a simple contribution table:

```{r example}
library(contribution)
data("demo")
demo
```

The accepted data format is a `data.frame` whose first column show the `role` and the other 
columns show the people or projects. This format is easy to create using R or other tools like Excel.  

For a 3-level contribution table, only `Minor` and `Major` are valid, a `NA` value should put 
in cell for no contribution.

```{r, fig.height=3}
generate(demo)
```

The **white** box represents **no contribution**, the **grey** box represents **minor contribution**, 
and the **black** box represents **major contribution**.

The table is nice, easy to read. The result is a `ggplot` object, so you can modify in your way!

You can also use other colors and `scale_fill_*` function from **ggplot2** to map colors:

```{r, fig.height=3}
library(ggplot2)
generate(demo, text_angle_x = 20, color_map = scale_fill_brewer(palette ="Oranges"))
```

When it is not easy to see the meaning of color, you can show the legend.

```{r, fig.height=3}
generate(demo, text_angle_x = 20, color_map = scale_fill_brewer(palette ="Set1"), show_legend = TRUE)
```

More usage please see [online documentation](https://openbiox.github.io/contribution/).

## To do

* Support special symbol for indicating equal work in a project/paper
* Accept author contributions information in machine-readable formats, e.g. in RIS and Bibtex citation documents provided on journal websites.

Owner

GitHub Events

Committers

Last synced: about 2 years ago

Issues and Pull Requests

Last synced: over 1 year ago

Packages