Skip to contents

Log overall and individual run time for repeated log_step() calls

Source: R/summarise_logs.R
summarise_logs.Rd

summarise_logs takes a list of log entries from log_step() and outpus a message with a summary of the time taken between each log call.

Usage

summarise_logs(logs, save_to = NULL)

Arguments

logs

A list of log_step() return values

save_to

A character value indicating the path to a text file to save the summary of the logs to. Default is NULL (do not save a log file).

Value

a character vector indicating the summary of the time taken between each log call

See also

Other Utilities: swap()

Examples

logs <- log_step("Example usage of log_summarise", header = TRUE)
#> |--------------------   Example usage of log_summarise   --------------------|
logs$step_one <- log_step("Step-1...")
#> 2025-12-03 20:52:27: Step-1...
# Do something
logs$step_two <- log_step("Step-2...")
#> 2025-12-03 20:52:27: Step-2...
# Do something else
logs$step_three <- log_step("Step-3...")
#> 2025-12-03 20:52:27: Step-3...
# Do something else
logs$done <- log_step("Complete")
#> 2025-12-03 20:52:27: Complete
# Summarise run times and write to file
summarise_logs(logs, save_to = tempfile())
#> 
#> Total time: 0ms 
#> --> Step-1...: 0ms
#> --> Step-2...: 0ms
#> --> Step-3...: 0ms