Type: Package
Title: Generate CRediT Author Statements
Version: 0.2.0
Description: 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.
License: MIT + file LICENSE
Encoding: UTF-8
URL: https://github.com/ropensci/CRediTas/, https://docs.ropensci.org/CRediTas/
BugReports: https://github.com/ropensci/CRediTas/issues/
RoxygenNote: 7.2.3
Suggests: knitr, rmarkdown, rvest, testthat (≥ 3.0.0)
Config/testthat/edition: 3
VignetteBuilder: knitr
NeedsCompilation: no
Packaged: 2023-04-12 09:57:28 UTC; jpueyo
Author: Josep Pueyo-Ros ORCID iD [aut, cre], Marcelo S. Perlin [rev] (github: @msperlin), João Martins [rev] (github: @zambujo)
Maintainer: Josep Pueyo-Ros <josep.pueyo@udg.edu>
Repository: CRAN
Date/Publication: 2023-04-13 09:10:02 UTC

Write CRediT author statement

Description

The function transforms the information in the template (from template_create) to a raw string following the CRediT authors statement format of "author1: contributions author2: contributions ..."

Usage

cras_write(
  cras_table,
  file,
  drop_authors = TRUE,
  overwrite = FALSE,
  markdown = TRUE,
  quiet = FALSE
)

Arguments

cras_table

A data.frame created using create_template()

file

The text file to be created. If not provided (default), the statement is returned as a string instead of written to a file.

drop_authors

If TRUE (default) the authors without contributions are removed from the statement. If FALSE, they are kept without contributions assigned.

overwrite

If TRUE, the file is overwritten. Otherwise, a error is triggered.

markdown

If TRUE (default), the authors are surrounded by ** to make them bold in markdown.

quiet

If TRUE and drop_authors is also TRUE, authors without contributions are silently dropped out. If FALSE, a warning is triggered in case any authors is dropped out.

Value

A text file with the CRediT authors statement or, if file is NULL (default), a character vector of length 1 with the statement that can be used in a Rmarkdown or quarto document using inline code: `r cras_write(cras_table, markdown = TRUE)`

Examples

# Generate a template and populate it (randomwly for this example)
cras_table <- template_create(authors = c("Josep Maria", "Jane Doe"))
cras_table[,2:ncol(cras_table)] <- sample(0:1, (ncol(cras_table)-1)*2,
                                          replace = TRUE)

# Create a temporary file just for this example
file <- tempfile()

# Write to the file
cras_write(cras_table, file, markdown = TRUE)

# Check the content of the file
readLines(file)

Get default roles for CRediT

Description

Get default roles for CRediT

Usage

roles_get()

Create a template to fill the CRediT author statement.

Description

Create a template to fill the CRediT author statement. (https://credit.niso.org). The template is a table where the authors are the rows and the columns are the roles.

Usage

template_create(authors, file, roles = roles_get())

Arguments

authors

A character vector with all the authors to be included in the statement.

file

If a path is provided, the template is saved as a csv for excel

roles

A character vector with the roles to be included in the statement. If NULL, it uses all the roles defined in the CRediT author statement.

Details

The dataframe can be edited in R or, if file is provided, it is exported to a csv to be edited manually in your preferred csv editor. The csv is created to be compatible with Microsoft Excel, since it is the most popular spreadsheet software among scientists. Therefore, it is separated by semicolon.

Value

A dataframe with a row for each author and a column for each role, filled with zeros.

Examples

template_create(authors = c("Josep Maria", "Jane Doe"))

Read a template from a csv file

Description

The template should be created using create_template()

Usage

template_read(file)

Arguments

file

A character vector with the path to the csv file

Value

a data.frame with the content of the csv file

Examples

# Create a temporary file for this example
file <- tempfile()

# Create a template and save it to a csv file
template_create(authors = c("Josep Maria", "Jane Doe"), file = file)

# Read the template back (in real life once it has been populated)
template_read(file)