MyNixOS website logo
Description

Generate CRediT.

A tiny package to generate CRediT author statements (<https://credit.niso.org/>). It provides three functions: create a template, read it back and generate the CRediT author statement in a text file.

CRediTas

R-CMD-check Status at rOpenSci Software PeerReview

The goal of CRediTas is to facilitate the tedious job of creating CRediT authors statements for scientific publications. Normally, the first author of a scientific paper organizes a table in a spreadsheet where all the authors self-state their contributions. Often too, it is the first author responsibility to state the contributions of all co-authors. However, at the end, the information has to be translated to the CRediT statement format of “Author 1: roles Authors 2: roles …” which is prone to errors and tedious, especially if there are many co-authors. The CRediTas package aims to make this easier by providing a template to be filled in form of a table (csv) and then converting this table to CRediT statement format.

Installation

You can install the development version of CRediTas from r-universe with:

install.packages("CRediTas", repos = "https://ropensci.r-universe.dev")

Example

The workflow is meant to work with three basic functions. First, we create a template table. It can be created as a data.frame and being populated in R. Or as a csv file and being populated in your preferred csv editor.

library(CRediTas)

template_create(authors = c("Alexander Humboldt", "Carl Ritter"), file = tempfile())

cras_table <- template_create(authors = c("Friedrich Ratzel", 
                                          "Pau Vidal de la Blache", 
                                          "Pau Vila",
                                          "Élisée Reclus"))
knitr::kable(cras_table)
AuthorsConceptualizationMethodologySoftwareValidationFormal AnalysisInvestigationResourcesData curationWriting - original draftWriting - review & editingVisualizationSupervisionProject administrationFunding acquisition
Friedrich Ratzel00000000000000
Pau Vidal de la Blache00000000000000
Pau Vila00000000000000
Élisée Reclus00000000000000

As you can see, the table is empty. So you must provide the information of who did what. You can use the fix function to fill the template directly in R:

fix(cras_table)

If you wrote the template to a file, then you can read it back to R as follows:

cras_table <- template_read(path_to_your_csv_file)

Once the cras_table is populated, for instance:

AuthorsConceptualizationMethodologySoftwareValidationFormal AnalysisInvestigationResourcesData curationWriting - original draftWriting - review & editingVisualizationSupervisionProject administrationFunding acquisition
Friedrich Ratzel10001100101010
Pau Vidal de la Blache10100100000011
Pau Vila00000000000000
Élisée Reclus00110010110111

A text file can be generated following the CRediT author statement format. Since drop = TRUE by default, the authors without contribution are removed from the statement, Pau Vila in this case.

textfile <- tempfile()

cras_write(cras_table, textfile, markdown = TRUE, quiet = TRUE)

If you open the text file, you will find this:

Friedrich Ratzel: Conceptualization, Formal Analysis, Investigation, Writing - original draft, Visualization, Project administration Pau Vidal de la Blache: Conceptualization, Software, Investigation, Project administration, Funding acquisition Élisée Reclus: Software, Validation, Resources, Writing - original draft, Writing - review & editing, Supervision, Project administration, Funding acquisition

Related packages

  • tenzing: Tenzing, an easy-to-use web-based app, allows researchers to generate reports about the contribution of each team member on a project using CRediT, for insertion into their manuscripts and for publishers to potentially incorporate into article metadata.
  • contribution: The goal of contribution is to generate contribution table for credit assignment in a project. This is inspired by Nick Steinmetz (see twitter https://twitter.com/SteinmetzNeuro/status/1147241138291527681).
Metadata

Version

0.2.0

License

Unknown

Platforms (75)

    Darwin
    FreeBSD
    Genode
    GHCJS
    Linux
    MMIXware
    NetBSD
    none
    OpenBSD
    Redox
    Solaris
    WASI
    Windows
Show all
  • aarch64-darwin
  • aarch64-genode
  • aarch64-linux
  • aarch64-netbsd
  • aarch64-none
  • aarch64_be-none
  • arm-none
  • armv5tel-linux
  • armv6l-linux
  • armv6l-netbsd
  • armv6l-none
  • armv7a-darwin
  • armv7a-linux
  • armv7a-netbsd
  • armv7l-linux
  • armv7l-netbsd
  • avr-none
  • i686-cygwin
  • i686-darwin
  • i686-freebsd
  • i686-genode
  • i686-linux
  • i686-netbsd
  • i686-none
  • i686-openbsd
  • i686-windows
  • javascript-ghcjs
  • loongarch64-linux
  • m68k-linux
  • m68k-netbsd
  • m68k-none
  • microblaze-linux
  • microblaze-none
  • microblazeel-linux
  • microblazeel-none
  • mips-linux
  • mips-none
  • mips64-linux
  • mips64-none
  • mips64el-linux
  • mipsel-linux
  • mipsel-netbsd
  • mmix-mmixware
  • msp430-none
  • or1k-none
  • powerpc-netbsd
  • powerpc-none
  • powerpc64-linux
  • powerpc64le-linux
  • powerpcle-none
  • riscv32-linux
  • riscv32-netbsd
  • riscv32-none
  • riscv64-linux
  • riscv64-netbsd
  • riscv64-none
  • rx-none
  • s390-linux
  • s390-none
  • s390x-linux
  • s390x-none
  • vc4-none
  • wasm32-wasi
  • wasm64-wasi
  • x86_64-cygwin
  • x86_64-darwin
  • x86_64-freebsd
  • x86_64-genode
  • x86_64-linux
  • x86_64-netbsd
  • x86_64-none
  • x86_64-openbsd
  • x86_64-redox
  • x86_64-solaris
  • x86_64-windows