expect_equivalent_images {tinysnapshot} | R Documentation |
Test if two image files are equivalent
Description
Test if two image files are equivalent
Usage
expect_equivalent_images(
current,
target,
tol = getOption("tinysnapshot_tol", default = 0),
metric = getOption("tinysnapshot_metric", default = "AE"),
fuzz = getOption("tinysnapshot_fuzz", default = 0),
style = getOption("tinysnapshot_plot_diff_style", default = c("old", "new", "diff")),
review = getOption("tinysnapshot_plot_review", default = TRUE),
diffpath = NULL
)
Arguments
current |
path to an image file |
target |
path to an image file |
tol |
distance estimates larger than this threshold will trigger a test failure. Scale depends on the |
metric |
string with a metric from |
fuzz |
relative color distance between 0 and 100 to be considered similar. |
style |
A character vector to control the panels of the diff image saved to file. The order and number of entries controls the side-by-side panels. Allowable values are: "old", "new", "diff". |
review |
logical. TRUE if a a diff plot should be saved to file for review when the expectation fails. |
diffpath |
path where to save an image which shows the differences between |
Value
A tinytest
object. A tinytest
object is a logical
with attributes holding information about the test that was run