Skip to contents

Audits the distribution of funding sources across works in a corpus. Funding metadata is extracted from either Crossref funder fields or OpenAlex funders and awards fields (also accepting legacy grants), depending on the source parameter.

The result includes funder counts, the proportion of works with known funding, and a concentration analysis.

Usage

sm_audit_funding(
  corpus,
  source = c("crossref", "openalex"),
  api_key = Sys.getenv("OPENALEX_API_KEY"),
  mailto = Sys.getenv("SCIMAPR_MAILTO"),
  call = rlang::caller_env()
)

# S3 method for class 'sm_audit_funding'
print(x, ...)

Arguments

corpus

An sm_corpus object.

source

Character. Where to look for funding data: "crossref" (uses DOIs to query Crossref funder metadata) or "openalex" (uses OpenAlex IDs, with DOI fallback).

api_key

OpenAlex API key, sent in the authorization header.

mailto

Contact address for Crossref requests.

call

Caller environment for error reporting.

x

An audit object to print.

...

Ignored.

Value

An sm_audit_funding S3 object containing:

funders

Tibble with columns funder_name, funder_doi, n_works, pct (percentage of checked works).

coverage

Proportion of checked works with at least one funder; NA if none could be checked, and 0 for an empty corpus.

n_works_total

Total number of works in corpus.

n_works_funded

Number of works with funding data.

n_works_checked

Works returned by the source.

n_works_failed

Works whose request failed; reported in a warning.

n_works_no_id

Works without an identifier for the chosen source.

source

The data source used.

Examples

# Works without a DOI need no Crossref lookup, so this runs offline and
# returns an empty audit.
corpus <- sm_example_corpus(n_works = 20, n_authors = 10)
corpus$works$doi <- NA_character_
funding <- sm_audit_funding(corpus, source = "crossref")
#> No funding data: works lack DOIs or identifiers.
print(funding)
#> 
#> ── <sm_audit_funding> ──────────────────────────────────────────────────────────
#> Data source: crossref
#> Works with funding data: 0 / 0 checked (NA%)
#> Failed lookups: 0; no identifier: 20.
#> No work could be checked.
#> 
#> No funding data found.
#> 
#> 
#> ── Limitations 
#> • Funding metadata is voluntarily reported by publishers and is often
#> incomplete, especially for older publications.
#> • Crossref and OpenAlex may not capture all funding sources; institutional or
#> departmental funding is rarely recorded.
#> • Funder names are not standardised across databases; the same funder may
#> appear under multiple names.
#> • Absence of funding data does not mean a work was unfunded; it may simply be
#> unreported.
if (FALSE) { # interactive()
# Live lookup: batched Crossref requests (the example DOIs are invented,
# so no funders are found).
corpus <- sm_example_corpus(n_works = 3, n_authors = 3)
funding <- sm_audit_funding(corpus, source = "crossref")
print(funding)
}