get_orcidlink: Obtain ORCID Links for Authors

In jss: Journal of Statistical Software Utilities

Obtain ORCID Links for Authors

Description

Query https://orcid.org in order to obtain orcidlinks for all authors in a JSS paper.

Usage

get_orcidlink(person = NULL, rows = 1L, verbose = TRUE, ...)

Arguments

person	character, person object, or jss object. In case of a character it can either be the file name of a JSS-style LaTeX file (by default the first LaTeX file in the current working directory is used) or person names (optionally enhanced by ORCID search strings).
rows	integer. The number of search results for each author.
verbose	logical. Should results be printed to the screen and the ORCID URL opened in the browser? If set to TRUE, results are returned invisibly.
...	further arguments passed to orcid.

Details

The get_orcidlink function is a utility to automatically search possible ORCID links for each author in a JSS paper. By default it reads the first LaTeX file in the current directory (assuming it is in JSS style), extracts the author names, and then uses orcid to query https://orcid.org/ for their possible ORCIDs.

All search results should be checked carefully because the chance to obtain an erroneous ORCID result is quite high if an author does not have an ORCID.

For authentication see https://docs.ropensci.org/rorcid/. An easy option is to run orcid_auth once and put the resulting UUID string into your .Rprofile as options(orcid_token = "...").

Value

get_orcidlink returns a character matrix with the author names, ORCID links in LaTeX format, and ORCID URLs. The matrix is returned invisible if verbose = TRUE (the default).

See Also

jss, orcid

Examples

## Not run: 
get_orcidlink("Achim Zeileis")

## End(Not run)

jss documentation built on July 12, 2024, 3:01 p.m.