contentanalysis (version 0.2.1)

get_crossref_references: Retrieve rich metadata from the CrossRef API for a given DOI

Description

Fetches a comprehensive set of metadata for a given DOI from the CrossRef API. The function parses the JSON response to extract main article details, author information, and the full reference list.

Usage

get_crossref_references(doi, mailto = NULL, output = "references")

Value

A list containing three main elements:

• main_metadata: A data frame with a single row containing key metadata about the article (e.g., DOI, title, journal, year, volume, issue).

• authors: A data frame listing all authors with their given name, family name, ORCID, and affiliation (if available).

• references: A data frame containing detailed information for each reference in the article (e.g., key, DOI, title, author, year).

Returns NULL if the DOI is not found or an error occurs.

Arguments

doi

Character string. The DOI (Digital Object Identifier) of the article.

mailto

Character string or NULL. An email address for polite API access, as recommended by CrossRef. This can lead to better service. Default is NULL.

output

Character string. The desired output content. c("all","metadata","authors","references").

Details

This function accesses the CrossRef REST API to retrieve structured metadata. It handles nested information like authors and references by parsing them into tidy data frames. Providing a mailto address in the user-agent is a best practice for API interaction.

Examples

if (FALSE) {
metadata <- get_crossref_references(
  "10.1007/s11192-016-1948-8",
  mailto = "[e-mail]",
  output = 'all'
)

# View main article metadata
print(metadata$main_metadata)

# View author information
head(metadata$authors)

# View reference list
head(metadata$references)
}