Skip to contents

For scripts and continuous integration: errors when the scan found anything that has not been reviewed and allowed, or when a file could not be read.

Usage

pii_check(findings, allow = character(), min_confidence = NULL, config = NULL)

Arguments

findings

The result of pii_scan().

allow

Field names or locators that have been reviewed and may stay.

min_confidence

The weakest findings that stop the check: "low", "medium" or "high"; "medium" unless the configuration says otherwise. Low-confidence findings, such as text that merely looks like names, are for reading, not for gating.

config

The project's configuration, from pii_config(). By default the one the scan used. Its allow entries count as reviewed.

Value

findings, invisibly, when nothing unallowed remains.

Examples

findings <- pii_scan(data.frame(village = rep(c("A", "B"), 10)))
pii_check(findings, allow = "village")