Skip to contents

Image Comparison

compare_images()
Compare Two Images
compare_images_batch()
Compare Multiple Image Pairs
compare_image_dirs()
Compare Images in Two Directories
compare_dirs_report()
Compare Directories and Generate HTML Report
summary(<odiffr_batch>) print(<odiffr_batch_summary>)
Summarize Batch Comparison Results
failed_pairs()
Get Failed Comparisons from Batch Results
passed_pairs()
Get Passed Comparisons from Batch Results
odiff_run()
Run odiff Command (Low-Level)
ignore_region()
Create an Ignore Region
plot_options()
Plot Rendering Options
odiff_preset()
Comparison Presets
compare_pdfs()
Compare Two PDF Files Page by Page
compare_pdf_dirs()
Compare PDF Files in Two Directories

Reviewing and Approving Changes

approve_changes()
Approve Changes as New Baselines
plot(<odiff_result>)
Plot an odiff Comparison
diff_image()
Get the Diff Image of a Comparison

Reporting

batch_report()
Generate HTML Report for Batch Comparison Results
batch_markdown()
Write a Markdown Summary of Batch Comparison Results
batch_junit()
Write Batch Comparison Results as JUnit XML
snapshot_report()
Report Failing Image Snapshots
use_odiffr_ci()
Add a GitHub Actions Workflow for Visual Tests
audit_record()
Create an Audit Record of Image Comparisons

testthat Expectations

expect_images_match() expect_images_differ()
testthat Expectations for Image Comparison
expect_snapshot_image()
Snapshot Testing for Images
compare_file_odiff()
Compare Files with odiff (for testthat and shinytest2 Snapshots)

Binary Management

install_odiff()
Install odiff
find_odiff()
Find the odiff Binary
odiff_available()
Check if odiff is Available
odiff_version()
Get odiff Version
odiff_info()
Display odiff Configuration Information
odiffr_update()
Download Latest odiff Binary
odiffr_cache_path()
Get Cache Directory Path
odiffr_clear_cache()
Clear the odiffr Cache