Skip to contents

Draw lint findings onto the scene

Source: R/lint.R
vl_lint_overlay.Rd

Puts a box around every finding that has geometry, and labels it with the rules that fired. For a graphics linter this is usually the fastest way to understand a report: a message says a mark is clipped, an outline shows you which one.

Usage

vl_lint_overlay(scene, findings = NULL, labels = TRUE)

Arguments

scene

A vl_scene(), or anything with an as_vellum_scene() method.

findings

The result of vl_lint(). NULL (default) lints scene.

labels

Whether to write the rule name beside each box.

Value

A new scene: scene with the overlay drawn on top, at page level.

Details

Findings with no geometry (a rule_error, or a rule reporting something scene-wide) have nothing to point at and are skipped.

See also

vl_lint(), vl_lint_assert()

Examples

s <- vl_scene(3, 2) |>
  draw(text_grob("off the edge", x = 1.6, y = 0.5)) |>
  draw(text_grob("tiny", x = 0.5, y = 0.2, gp = vl_gpar(fontsize = 2)))
# display(vl_lint_overlay(s))
nrow(vl_lint(s)) > 0
#> [1] TRUE