library(scienceverse)
#> 
#> ************
#> Welcome to scienceverse For support and examples visit:
#> http://scienceverse.github.io/
#> - Get and set global package options with: scienceverse_options()
#> ************

CRediT

Scienceverse supports the CRediT taxonomy for authorship roles.

Use the function credit_roles() to view a list of possible roles and their abbreviations. Set display to "names" or "abbr" to just list the names or abbreviations.

credit_roles()
#> [1/con] Conceptualization: Ideas; formulation or evolution of overarching research goals and aims.
#> [2/dat] Data curation: Management activities to annotate (produce metadata), scrub data and maintain research data (including software code, where it is necessary for interpreting the data itself) for initial use and later re-use.
#> [3/ana] Formal analysis: Application of statistical, mathematical, computational, or other formal techniques to analyse or synthesize study data.
#> [4/fun] Funding acquisition: Acquisition of the financial support for the project leading to this publication.
#> [5/inv] Investigation: Conducting a research and investigation process, specifically performing the experiments, or data/evidence collection.
#> [6/met] Methodology: Development or design of methodology; creation of models.
#> [7/adm] Project administration: Management and coordination responsibility for the research activity planning and execution.
#> [8/res] Resources: Provision of study materials, reagents, materials, patients, laboratory samples, animals, instrumentation, computing resources, or other analysis tools.
#> [9/sof] Software: Programming, software development; designing computer programs; implementation of the computer code and supporting algorithms; testing of existing code components.
#> [10/sup] Supervision: Oversight and leadership responsibility for the research activity planning and execution, including mentorship external to the core team.
#> [11/val] Validation: Verification, whether as a part of the activity or separate, of the overall replication/reproducibility of results/experiments and other research outputs.
#> [12/vis] Visualization: Preparation, creation and/or presentation of the published work, specifically visualization/data presentation.
#> [13/dra] Writing - original draft: Preparation, creation and/or presentation of the published work, specifically writing the initial draft (including substantive translation).
#> [14/edi] Writing - review & editing: Preparation, creation and/or presentation of the published work by those from the original research group, specifically critical review, commentary or revision -- including pre- or post-publication stages.
credit_roles(display = "names")
#>  [1] "Conceptualization"          "Data curation"             
#>  [3] "Formal analysis"            "Funding acquisition"       
#>  [5] "Investigation"              "Methodology"               
#>  [7] "Project administration"     "Resources"                 
#>  [9] "Software"                   "Supervision"               
#> [11] "Validation"                 "Visualization"             
#> [13] "Writing - original draft"   "Writing - review & editing"
credit_roles(display = "abbr")
#>  [1] "con" "dat" "ana" "fun" "inv" "met" "adm" "res" "sof" "sup" "val" "vis"
#> [13] "dra" "edi"

ORCiD

Scienceverse supports recording and searching for ORCiDs. Every researcher should have an ORCiD to link their papers and avoid problems with name changes.

You can use the get_orcid() function to search for an ORCiD quickly, although you might need to go to their website for more advanced search if they have a common name and you get multiple hits. This function requires a web connection.

ldb_orcid <- get_orcid("DeBruine", "Lisa")

Adding an author to a study

You can add authors to a study object with the add_author() function. Authors must have a surname, and you can optionally add a given name, orcid and roles (using the names, abbreviations, or indices above). You can also make up any other category of information, such as email or affiliation.

# set up an empty study
s <- study("Demo") 

s <- add_author(s, 
                surname = "DeBruine",
                given = "Lisa M.",
                orcid = ldb_orcid, 
                roles = c("con", "sof", "edi"),
                email = "debruine@gmail.com") %>%
  add_author(surname = "Lakens",
             given = "Daniel",
             orcid = get_orcid("Lakens", "Daniel"),
             roles = c(1, 13, 14))

s$authors
    • orcid: 0000-0002-7523-5539
    • name:
      • surname: DeBruine
      • given: Lisa M.
    • roles:
      1. Conceptualization
      2. Software
      3. Writing - review & editing
    • email:
    • orcid: 0000-0002-0247-239X
    • name:
      • surname: Lakens
      • given: Daniel
    • roles:
      1. Conceptualization
      2. Writing - original draft
      3. Writing - review & editing

CRediT format

You can use the author_jats() function to format a study’s author list in the machine-readable JATS format requested by CRediT.

jats <- author_jats(s)

The output of author_jats() looks like this in the source code of a webpage:

<contrib-group>
<contrib>
  <contrib-id authenticated="true" contrib-id-type="orcid">https://orcid.org/0000-0002-7523-5539</contrib-id>
  <string-name>
    <surname>DeBruine</surname>
    <given-names>Lisa M.</given-names>
  </string-name>
  <role vocab="credit"
      vocab-identifier="http://credit.niso.org/"
      vocab-term="Conceptualization"
      vocab-term-identifier="http://credit.niso.org/contributor-roles/conceptualization/">Conceptualization</role>
  <role vocab="credit"
      vocab-identifier="http://credit.niso.org/"
      vocab-term="Software"
      vocab-term-identifier="http://credit.niso.org/contributor-roles/software/">Software</role>
  <role vocab="credit"
      vocab-identifier="http://credit.niso.org/"
      vocab-term="Writing - review & editing"
      vocab-term-identifier="http://credit.niso.org/contributor-roles/writing-review-editing/">Writing - review & editing</role>
</contrib>
<contrib>
  <contrib-id authenticated="true" contrib-id-type="orcid">https://orcid.org/0000-0002-0247-239X</contrib-id>
  <string-name>
    <surname>Lakens</surname>
    <given-names>Daniel</given-names>
  </string-name>
  <role vocab="credit"
      vocab-identifier="http://credit.niso.org/"
      vocab-term="Conceptualization"
      vocab-term-identifier="http://credit.niso.org/contributor-roles/conceptualization/">Conceptualization</role>
  <role vocab="credit"
      vocab-identifier="http://credit.niso.org/"
      vocab-term="Writing - original draft"
      vocab-term-identifier="http://credit.niso.org/contributor-roles/writing-original-draft/">Writing - original draft</role>
  <role vocab="credit"
      vocab-identifier="http://credit.niso.org/"
      vocab-term="Writing - review & editing"
      vocab-term-identifier="http://credit.niso.org/contributor-roles/writing-review-editing/">Writing - review & editing</role>
</contrib>
</contrib-group>