Skip to contents

Check documents and bibliographies

check_file()
Check a document or bibliography file for retracted references
check_bib()
Check a BibTeX or BibLaTeX bibliography for retracted references
check_dois()
Check a set of DOIs or PMIDs for retraction
check_refs()
Check a data frame of references for retraction
check_zotero()
Check a Zotero library for retracted references
check_preprint()
Check whether a preprint has been withdrawn

PubMed Central

check_pmc()
Check the reference lists of open-access PubMed Central articles
pmc_articles()
Per-article open-access summary from a check_pmc() result
pmc_fetch_xml()
Retrieve open-access PMC full-text XML for a PMCID

Results and reports

retracted()
Subset of references flagged as retracted (or otherwise notable).
render_report()
Render a retraction result as an HTML or Markdown report

Interpreting results

explain_result()
Explain the verdict for each reference in a result
compare_sources()
Summarize cross-source (dis)agreement in a result
exposure_score()
Retraction-exposure summary, with denominator diagnostics.
classify_timing()
Classify each citation relative to the document's date.
manuscript_date_of()
Best-effort authoring date of a manuscript file (git commit date, else mtime).
snapshot_info()
Report the local snapshot's data version and freshness
badge_json()
Write a shields.io endpoint badge for a checked result.

Monitoring and systematic reviews

retraction_watch_save()
Save a checked result as a named watch baseline.
retraction_watch_diff()
Report references newly flagged since the saved baseline.
check_included_studies()
Check the included studies of a systematic review or meta-analysis.

Workflow integration

retraction_scan()
Scan files for retracted citations.
retraction_main()
CLI main: scan files and exit per a fail policy.
retraction_knit_check()
Fail (or warn) a knit when the document cites retracted work.
retraction_addin_check_active()
RStudio addin: check retractions in the active source document.
retraction_app()
Launch the retraction triage Shiny app
fail_policy()
A fail policy shared by the CLI, GitHub Action, and knit gate.
evaluate_policy()
Evaluate a checked result against a fail policy

Export, annotation, and queries

export_result()
Export a checked result to CSV, JSON, or Excel.
annotate_bib()
Annotate a BibTeX/BibLaTeX file, marking retracted entries.
suggest_alternatives()
Suggest alternatives to a retracted work
author_retractions()
Retractions attributed to an author.
journal_retractions()
Retraction summary for a journal.
primary_reason_bucket()
Primary (lossy) reason bucket: the first matching bucket.
reason_buckets()
All matching reason buckets (multi-label).
reason_summary()
Tabulate primary reason buckets across a checked result.

The retraction_result object

print(<retraction_result>)
Print a retraction result.
summary(<retraction_result>)
Summarize a retraction result as a status tally.
print(<retraction_review>)
Print a systematic-review check, leading with denominators.
as_tibble(<retraction_result>)
Coerce a retraction result to a plain tibble.
as.data.frame(<retraction_result>)
Coerce a retraction result to a data frame.

Sources

list_backends()
Names of all registered backends.

Offline snapshot

retraction_sync()
Download or update a local snapshot of the retraction corpus
retraction_cache_dir()
Location of the retraction cache directory
retraction_clear_cache()
Clear the package cache
retraction_snapshot_parquet()
Export the local snapshot to a Parquet file

Identifiers

normalize_doi()
Normalize a DOI.
normalize_pmid()
Normalize a PubMed identifier to bare digits.
normalize_pmcid()
Normalize a PubMed Central identifier
normalize_title()
Normalize a title for fuzzy comparison only.

Data

retraction_example
Example references for demonstrating retraction checks