Skip to contents

Fetch works from Crossref

Source: R/fetch-crossref.R
sm_fetch_crossref.Rd

Query the Crossref API for scholarly works and return the results as an sm_corpus.

Uses offset-based pagination to retrieve up to n_max works. Providing a mailto address enables the polite pool (faster rate limits).

Usage

sm_fetch_crossref(
  query = NULL,
  filter = NULL,
  n_max = 200L,
  mailto = Sys.getenv("SCIMAPR_MAILTO"),
  engine = c("native", "rcrossref", "auto"),
  verbose = TRUE,
  call = rlang::caller_env()
)

Arguments

query

Free-text search query. If NULL, filter must be supplied.

filter

Crossref filter syntax, e.g. "from-pub-date:2020,type:journal-article".

n_max

Maximum number of works to return (default 200).

mailto

Email address for the polite pool. Read from SCIMAPR_MAILTO env var by default.

engine

One of "native" (built-in httr2 client), "rcrossref" (use the rcrossref package), or "auto" (use rcrossref if available, otherwise native).

verbose

Print progress messages?

call

Caller environment for error reporting.

Value

An sm_corpus object.

See also

Other fetchers: sm_fetch_arxiv(), sm_fetch_biorxiv(), sm_fetch_openalex(), sm_fetch_orcid(), sm_fetch_overton(), sm_fetch_pubmed(), sm_fetch_semantic_scholar()

Examples

if (FALSE) { # \dontrun{
corpus <- sm_fetch_crossref(query = "bibliometrics", n_max = 10)
print(corpus)
} # }