Skip to contents

Retrieve the run ledger from a precise_dist() result

Source: R/precise_read.R
precise_run_report.Rd

Returns the per-metric run ledger — one row per requested metric with columns distance, metric, type, status ("completed", "errored", "skipped", "unavailable"), reason, message, and time_taken_seconds — attached by precise_dist and precise_read.

Usage

precise_run_report(x)

Arguments

x

An object returned by precise_dist or precise_read.

Value

The ledger tibble, or (with a message) invisible(NULL) when x carries no ledger.

See also

precise_dist, precise_read

Author

Brian Muchmore

Examples

x <- matrix(seq_len(18), nrow = 6)
result <- precise_dist(x, dists = "euclidean", verbose = FALSE)
precise_run_report(result)
#> # A tibble: 1 × 7
#>   distance  metric    type     status    reason message time_taken_seconds
#>   <chr>     <chr>     <chr>    <chr>     <chr>  <chr>                <dbl>
#> 1 euclidean euclidean distance completed NA     NA                 0.00100