Skip to contents

Create an Audit Trail

Source: R/audit-snap.R, R/audit-trail.R
audit_trail.Rd

Creates an audit trail object that captures metadata snapshots at each step of a data pipeline. The trail uses environment-based reference semantics so it can be modified in place inside pipes via audit_tap().

Usage

# S3 method for class 'audit_snap'
print(x, ...)

audit_trail(name = NULL)

# S3 method for class 'audit_trail'
print(x, show_custom = TRUE, ...)

Arguments

x

An object to print.

...

Additional arguments (currently unused).

name

Optional name for the trail. If NULL, a timestamped name is generated automatically.

show_custom

Logical. If TRUE (default), inline annotations (one indented line per custom function) are printed below each snapshot that has custom diagnostics. Set to FALSE to suppress them and display only the main timeline table.

Value

An audit_trail object (S3 class wrapping an environment).

See also

Other audit trail: audit_diff(), audit_report(), audit_tap(), tab_tap()

Examples

trail <- audit_trail("my_analysis")
print(trail)
#> 
#> ── Audit Trail: "my_analysis" ──────────────────────────────────────────────────
#> Created: 2026-03-24 12:14:30
#> Snapshots: 0
#> 
#> ℹ No snapshots recorded yet. Use `audit_tap()` in a pipe to add snapshots.