leakr (version 0.1.0)

leakr_audit: Audit dataset for data leakage

Description

This function audits a dataset for potential data leakage, running a series of predefined detectors and generating a comprehensive report with detailed findings.

Usage

leakr_audit(
  data,
  target = NULL,
  split = NULL,
  id = NULL,
  detectors = NULL,
  config = list()
)

Value

A leakr_report object containing the audit results, including summary, evidence, and metadata.

Arguments

data

The dataset to be audited (data frame or tibble).

target

The target variable (optional). If NULL, no target variable is assumed.

split

The split variable used for training/test split (optional). If NULL, no split is assumed.

id

The unique identifier for each row (optional). If NULL, no id is used.

detectors

A vector of detector names to run (optional). If NULL, all available detectors will be used.

config

A list of configuration parameters for the audit. Defaults to an empty list.

Examples

# \donttest{
# Basic audit on iris dataset
report <- leakr_audit(iris, target = "Species")
print(report)
# }