Repository files navigation

The goal ofcontribution is to generatecontribution table forcredit assignment in a project. This is inspired by Nick Steinmetz (seetwitterhttps://twitter.com/SteinmetzNeuro/status/1147241138291527681).

Authors contributions sections are new and still don’t appear in majorjournals, but can be improved. Rather than text listing each author’scontributions, the same data can be presented as a table with rowscorresponding to contributions and columns for each author.

Advantages include:

1. Graphics are faster and easier to comprehend. They are also easierto locate in the document.

2. This format can be readily augmented with additional information,such as distinguishing between ‘major’ and ‘minor’ contributionsof each type.

3. This format can be read as easily in either direction, answeringboth “Who did X?” and “What did person Y do?” equally.

4. This format lends itself to a nice extension for including yourauthor contribution information on your CV: a similar table whereeach column is one of your papers.

A difficulty with this is the diversity of terminology used, whichwould be helped by refinement and more widespread adoption of theCRediT framework (https://casrai.org/credit/).

• Support table type
  • 3-level contribution (i.e. ‘None’, ‘Minor’ and ‘Major’)
  • numeric contribution
• Datasetpalette contains 27 color maps

An R Shiny application can be found athttps://shiny.hiplot-academic.com/contribution-table/ orhttps://shixiangwang.shinyapps.io/contribution/. Corresponding sourcecode is available athttps://github.com/ShixiangWang/shinyapps/tree/main/contribution-table.

You can install the released version of contribution fromCRAN with:

install.packages("contribution")

And the development version fromGitHub with:

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

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

library(contribution)data("demo")demo#> # A tibble: 5 × 4#>   Class              WWP   NAS   TM#>   <chr>              <chr> <chr> <chr>#> 1 Designed research  <NA>  Major Major#> 2 Performed research <NA>  Major <NA>#> 3 Developed tool     Major Minor <NA>#> 4 Analyzed data      Major Minor Minor#> 5 Wrote the paper    Major Minor Major

The accepted data format is adata.frame whose first column show therole and the other columns show the people or projects. This format iseasy to create using R or other tools like Excel.

For a 3-level contribution table, onlyMinor andMajor are valid, aNA value should put in cell for no contribution.

generate(demo)

Thewhite box representsno contribution, thegrey boxrepresentsminor contribution, and theblack box representsmajor contribution.

The table is nice, easy to read. The result is aggplot object, so youcan modify in your way!

You can also use other colors andscale_fill_* function fromggplot2 to map colors:

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 thelegend.

generate(demo,text_angle_x=20,color_map= scale_fill_brewer(palette="Set1"),show_legend=TRUE)

More usage please seeonlinedocumentation.

• 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 journalwebsites.