NEWS

resultcheck 0.2.1 (2026-05-08)

snapshot() now improves script-name detection in non-interactive and test contexts by skipping editor-context lookup there and relying on call-stack source references before falling back to "interactive".

snapshot() now uses rstudioapi::getSourceEditorContext()$path (in RStudio/Positron) as the primary method to detect the calling script name, falling back to the call stack and then "interactive".
snapshot() and serialize_value() now apply built-in class-based method defaults automatically when no explicit method argument is provided. Statistical model classes (e.g. lm, glm, coxph, kmeans) are serialized using broom::tidy, broom::glance, and/or broom::augment when the broom package is available.
When broom is not installed, built-in class defaults that rely on it are silently skipped and the print + str fallback is used. User-configured class defaults that reference unavailable packages still raise an error.
The full list of supported classes is in inst/extdata/snapshot-method-defaults.R.
Added broom to Suggests to enable the new built-in class defaults.
Add "Get Started" and FAQ vignettes to clarify workflow and common questions.

Rename project config file from resultcheck.yml to _resultcheck.yml (legacy resultcheck.yml is still read for backward compatibility).
Change default snapshot location to tests/_resultcheck_snaps/ instead of _resultcheck_snapshots/.
Add configurable snapshot directory support via snapshot.dir in _resultcheck.yml.
Add with_example() to run package examples in temporary projects under tempdir(), avoiding writes to user home/package/getwd locations.
Update examples/docs to be executable without \\dontrun{} and use setup_sandbox() with no required file arguments for empty sandboxes.
snapshot() now warns with the exact target path before interactive writes; default path remains configurable via snapshot.dir in _resultcheck.yml.

Add precision rounding option in _resultcheck.yml to stabilize snapshot comparisons across runs.
Add [ignored] markers in snapshot() output to explicitly indicate excluded components.

Fixed snapshot inconsistencies caused by variable serialization width and directory checks, improving reliability of result comparisons.
Added method parameter to snapshot() for print/str/both serialization.

snapshot() — create and verify human-readable snapshots of R objects (models, data frames, tables, vectors, etc.). Interactive mode warns and prompts; testing mode (inside run_in_sandbox()) errors on mismatch.
setup_sandbox() — copy project files and/or directories into a temporary directory for isolated testing. Accepts individual file paths or entire subdirectories.
run_in_sandbox() — execute an R script inside the sandbox with the working directory set to the sandbox root, while find_root() and snapshot() transparently resolve back to the original project root.
cleanup_sandbox() — remove the sandbox directory after testing.
find_root() — locate the project root using _resultcheck.yml, .Rproj, or .git as markers.