% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/audit-snap.R, R/audit-trail.R
\name{print.audit_snap}
\alias{print.audit_snap}
\alias{audit_trail}
\alias{print.audit_trail}
\title{Create an Audit Trail}
\usage{
\method{print}{audit_snap}(x, ...)

audit_trail(name = NULL)

\method{print}{audit_trail}(x, show_custom = TRUE, ...)
}
\arguments{
\item{x}{An object to print.}

\item{...}{Additional arguments (currently unused).}

\item{name}{Optional name for the trail. If \code{NULL}, a timestamped name is
generated automatically.}

\item{show_custom}{Logical. If \code{TRUE} (default), inline annotations (one
indented line per custom function) are printed below each snapshot that has
custom diagnostics. Set to \code{FALSE} to suppress them and display only the
main timeline table.}
}
\value{
An \code{audit_trail} object (S3 class wrapping an environment).
}
\description{
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 \code{\link[=audit_tap]{audit_tap()}}.
}
\examples{
trail <- audit_trail("my_analysis")
print(trail)

}
\seealso{
Other audit trail:
\code{\link[=audit_diff]{audit_diff()}},
\code{\link[=audit_report]{audit_report()}},
\code{\link[=audit_tap]{audit_tap()}},
\code{\link[=tab_tap]{tab_tap()}}
}
\concept{audit trail}
